Skip to main content
POST
Registers a customer for virtual card creation. This enrollment step is required before issuing any virtual cards to the customer. Fields that are already stored on the customer’s profile may be omitted.
Requires an Idempotency-Key header.

Authorizations

X-Api-Key
string
header
required

Your API key (yativo_pk_...) from Developers → API Keys. Send together with X-Api-Secret.

X-Api-Secret
string
header
required

Your API secret (yativo_sk_...), shown once when the key is created.

Headers

Idempotency-Key
string
required

A unique string per request to ensure idempotent processing.

Body

application/json
customer_id
string<uuid>
required

The ID of the customer to activate. Must exist in your customers table.

user_photo
string

Customer photo (base64 or URL). Required if not already on the customer's profile.

idType
enum<string>

Government ID type (e.g. "passport", "drivers_license", "national_id"). Required for Nigerian customers.

Available options:
passport,
drivers_license,
national_id
customer_idFront
string

Front image of the customer's government-issued ID. Required if not already on the customer's profile.

customer_idNumber
string

Government-issued ID number. Required if not already on the customer's profile.

customer_address
object

Customer address. Each sub-field is required if not already on the customer's profile.

Response

200 - application/json

Customer registered for virtual cards

success
string
Example:

"User registered successfully."