Skip to main content
POST
kind is always business. Any field you leave out is taken from prefill. Individual customers return 422 with code: use_onboarding_page. See Verify a business customer with your own form.

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.

Path Parameters

customer_id
string
required

Body

application/json
kind
enum<string>
required

Always business. Individual customers add their ID and selfie on the onboarding page.

Available options:
business
business_name
string

Legal business name. Required unless prefilled.

country
string

Country of incorporation, ISO 3166-1 alpha-2. Required unless prefilled.

Required string length: 2
Example:

"US"

business_structure
string

Legal structure valid for country. Leave it out for countries without structures.

Example:

"private_corporation"

business_tax_identification_number
string

EIN (US), Business Number (CA), Company Number (UK).

place_of_incorporation
string

State or region of incorporation.

Example:

"DE"

business_website
string<uri>
address
object
first_name
string

Business representative. Required unless prefilled.

last_name
string

Business representative. Required unless prefilled.

date_of_birth
string<date>

Representative's date of birth, YYYY-MM-DD, 18 or older.

tax_identification_number
string

Representative's personal tax ID. Sent once and not stored.

Response

Verification submitted

status
string
Example:

"success"

status_code
integer
Example:

201

message
string
Example:

"Verification submitted"

data
object