Skip to main content
POST
Submit verification data

Authorizations

Authorization
string
header
required

API key sent in the Authorization header.

Path Parameters

customer_id
string<uuid>
required

The customer (child org) ID. Must belong to the caller's organization or a direct child.

Body

application/json

Personal data a partner submits on the customer's behalf.

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.

Response

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

Where the customer's verification stands after a partner write. status is the same value GET /ramp/customer/{customer_id}/kyc reports, so there is one vocabulary across both.

customerId
string<uuid>
required
status
enum<string>
required

The customer's overall verification status. A write never moves it on its own.

Available options:
not_started,
in_progress,
submitted,
approved,
denied