Skip to main content
POST
Submit verification data

Authorizations

Authorization
string
header
required

API key sent in the Authorization header, with no Bearer prefix.

Path Parameters

organizationId
string<uuid>
required

The organization this call acts for: your API key's organization or one of its customer organizations. Any other id returns 404 not-found.

Body

application/json

Personal data a partner submits on the customer's behalf. A Mexican customer (country: "MEX") needs a CURP and RFC to complete verification.

firstName
string
required
lastName
string
required
dateOfBirth
string
required

YYYY-MM-DD. Any other format is a 400.

Example:

"1990-01-01"

taxId
string
required

The customer's tax identification number. The RFC for a Mexican customer.

Example:

"XAXX010101000"

country
string
required

The customer's country, as an ISO 3166-1 alpha-3 code. Alpha-2 codes and country names are rejected. This is the one country field for the customer (there is no separate nationality), and its value routes them to their country's requirements.

Example:

"MEX"

address
object
required

The customer's residential address. Required, and it must match the identity document you upload; the provider cross-checks the two.

additionalInfo
object

Information beyond the standard personal data, which some verifications ask for.

Response

Accepted and being applied. The customer's current verification status is returned.

Where the customer's verification stands after a write. status is the same value GET /organization/{organizationId}/kyc reports.

organizationId
string<uuid>
required
status
enum<string>
required
  • notStarted: verification has not started.
  • inProgress: the customer started but has not submitted everything.
  • submitted: submitted and waiting for review.
  • approved: cleared.
  • denied: rejected, or a previous approval was revoked.
Available options:
notStarted,
inProgress,
submitted,
approved,
denied