API Reference
Home

Submit requirement for entity

post
https://sandbox-compliance.api.reap.global/entity//ukyc
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier (ID) of the entity.

Body Params

Data required for the submission of entity requirements.

string
required
length between 1 and 255

Caller-provided external user identifier.

string
^\d{9}$

Optional 9-digit numeric card processor public token. Required for BIN Sponsorship flows.

string
length between 3 and 3

Optional ISO 3166-1 alpha-3 BIN program country code. When provided, the matching jurisdictionData block must be supplied. When binCountry is MEX and identity.nationality is MEX, a CURP document requirement is created automatically in PENDING status.

provider
object
identity
object
required
document
array of objects
required
length ≥ 1

Array of identity documents. Exactly one IDV document is required; a POA document is optional at submission (at most one). Whether a POA is required to complete verification depends on your business and user configuration. When both are provided, their types must differ, and their document numbers must differ if both supply one.

document*
string
enum
required

Document category. IDV (Identity Verification): PASSPORT, ID_CARD, DRIVERS_LICENCE, RESIDENCE_PERMIT. POA (Proof of Address): ID_CARD, DRIVERS_LICENCE, RESIDENCE_PERMIT, UTILITY_BILL, UTILITY_BILL2. At most one document of each category is allowed.

Allowed:
string
enum
required

Document type. For IDV: PASSPORT, ID_CARD, DRIVERS_LICENCE, RESIDENCE_PERMIT. For POA: ID_CARD, DRIVERS_LICENCE, RESIDENCE_PERMIT, UTILITY_BILL, UTILITY_BILL2.

Allowed:
string
length ≤ 50

Document number. Required for IDV documents; optional for POA documents (utility bills / bank statements often have no consistent number) — omit the key when there is no number.

string
required
length between 3 and 3

ISO 3166-1 alpha-3 country code of the issuing country.

date

YYYY-MM-DD. Optional. When provided, must not be in the future.

date

YYYY-MM-DD. Optional. When provided, must be after issuingDate and must not be in the past.

address
object
required
liveness
object
jurisdictionData
object

Jurisdiction-specific data keyed by ISO 3166-1 alpha-3 country code. Required keys depend on binCountry.

Headers
string
enum

Universal KYC API version. Defaults to 1 when absent. Unsupported values return 400.

Allowed:
Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?