Skip to main content
POST
Get user token

Authorizations

api_key
string
header
required

Body

application/json

User alias (phone with country code).

Resolve an existing user by phone or email for partner “get user token” style calls.

If both email and phoneNumber fields are sent in the same request, email takes precedence and phoneNumber will be ignored.

phoneNumber
string

required.

Mobile phone number with country code. Must be a valid mobile phone number. Example: +5215521206703 for MX.

email
string

Email address.

countryCode
string

Country code. ISO 3166-1 alpha-2.

Response

200 — OK. User resolved; optional CIP fields depend on tenant.

Scenarios for this response (keep in sync with testing-sandbox.mdx):

See also Full scenario matrix.

Successful user resolution for partner token endpoints (id + optional CIP snapshot).

userId
string
required

User ID

status
string

Status of the user's CIP process

Available options: Completed, UpgradePending, UpgradeInProgress, UpgradeFailed, UpgradeSoftFailed, AccountUpgradeInProgress

statusDetail
enum<string>

Status detail of the user's CIP process

Available options:
None,
InvalidAddress,
InvalidEMail,
UnreadableDoc,
ProvideAdditionalInfo,
InvalidPersonalData,
OtpPrivacyMissing,
OtpContractMissing,
Compliance,
ComplianceBlocked,
OfacFailed