Skip to main content
POST
Check recipient (Venezuela)

Authorizations

Authorization
string
header
required

User API authentication token with format cash_<64-char-hex>. Sample value cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2.

Body

application/json
accountId
string<uuid>
required
Example:

"YOUR_ACCOUNT_UUID"

email
string<email>
required
Example:

"payer@example.com"

documentoIdentidad
string
required

Digits only. A matching V-, J-, P-, or E- prefix is stripped.

Example:

"00000000"

tipoDocumento
string
required

Catalogue value from country.documentTypes. V, J, P, or E.

Example:

"V"

numeroCuenta
string
firstName
string
lastName
string
prefijoTelefono
string
Example:

"+58"

numeroTelefono
string
Example:

"0000000000"

direccion
string
ciudad
string

Response

Recipient check result. Does not create a transaction.

status
enum<string>
required
Available options:
ready,
kyc_approved_no_account,
kyc_in_progress,
kyc_not_started,
kyc_declined
empleado_id
integer

Omitted when the email is not registered. Included for an existing recipient, including kyc_declined.

kyc_url
string<uri>

For an existing recipient, kyc_not_started includes this when a session URL was issued. kyc_in_progress includes it only when the status payload has one, or when a payout on this accountId already stored one. Never taken from another account's transactions. Omitted on kyc_not_started for an email that is not registered.

code
enum<string>

Present only when status is kyc_declined.

Available options:
KOLLAT_KYC_DECLINED