KYC / KYB Verification

Yativo requires identity verification before customers can access payment services such as virtual accounts, send money, and payment rails. Individual users go through KYC (Know Your Customer) and businesses go through KYB (Know Your Business).

Environments

Environment	Base URL
Production API	`https://api.yativo.com/api/v1`
Sandbox API	`https://smtp.yativo.com/api/v1`
KYC platform (production)	`https://kyc.yativo.com`
KYC platform (sandbox)	`https://kyc-sandbox.yativo.com`

KYC and KYB submissions, partial updates and lookups go to the KYC platform, not the main API. Use https://kyc-sandbox.yativo.com with sandbox customers and https://kyc.yativo.com in production. Read the host from config so you can switch. The KYC platform endpoints don’t need your API key. Endpoints on the main API, such as GET /customer/{customer_id}, do. See Sandbox KYC.

Coding assistants can read the KYC lookup data and the KYC platform guide through its MCP server at https://kyc.yativo.com/api/mcp (read-only).

Integration approaches

Approach	Best for	Effort
Hosted KYC/KYB link	Quick integration, iframe embed	Low
API submission	Programmatic flow, native UI	High

Hosted URLs:

Individual: https://kyc.yativo.com/individual/{customer_id}
Business: https://kyc.yativo.com/business/{customer_id}

On the hosted business form, the customer can click Save draft on any section to keep unfinished answers and come back later. Drafts aren’t checked or sent for verification. The customer can’t submit until each drafted section is saved with Next.

Build your form with the lookup endpoints

If you collect KYC or KYB data in your own UI, fill every dropdown from the KYC platform’s lookup endpoints instead of hardcoding values. They live on https://kyc.yativo.com/api, and you can try each one from the API reference.

Country

Load List Countries once. Send the two-letter code for nationality, every address country and issuing_country.

Address

When the customer picks a country, load List Subdivisions for the state dropdown, and Get Postal Code Format to validate postal_code as they type.

ID documents

Load List ID Types for the issuing country to fill identifying_information[].type.

Occupation or industry

Individuals: List Occupations for most_recent_occupation_code. Businesses: List Business Industries for business_industry. Both lists are long, so use a searchable field.

Purpose, funds and volume

Individuals: account purposes, sources of funds and expected monthly payments. Businesses: account purposes and sources of funds. The business lists are different from the individual ones.

Business activity (KYB only)

List Transaction Currencies for collection_currencies and List Transaction Countries for beneficiary_geographies.

Verification flow

Create a customer

Call POST /customer to create a customer record and receive a customer_id.

Upload documents (if using API)

Use POST /storage/upload to upload files and receive back a hosted URL. Pass those URLs in the KYC payload. Alternatively, embed files as base64-encoded strings.

Submit KYC or KYB

POST to https://kyc.yativo.com/api/individual-kyc/submit or https://kyc.yativo.com/api/business-kyc/submit.

Watch the endorsements

Listen for the endorsement.updated webhook, or read the customer’s endorsement list with GET /customer/{customer_id}. This is the only place verification results appear. See Track verification with endorsements.

Use each approved service

Each service becomes available when its endorsement’s status is approved. For example, a USD virtual account needs the endorsement that GET /business/virtual-account/currencies-and-endorsements lists for USD.

Upload documents

Before submitting KYC, upload any document files you will reference. Every file must be PDF, JPG, JPEG, PNG, HEIC or TIF, and between 5 KB and 30 MB. ID document images (image_front_file, image_back_file, uploaded_documents[*].file) on individual KYC accept PDF, JPG, JPEG and PNG only. Each file field accepts a hosted URL, a base64 data URI (data:image/jpeg;base64,...) or a multipart/form-data upload. Every file is virus-scanned.

POST /storage/upload

Send the file as multipart/form-data with the field name document.

curl -X POST 'https://api.yativo.com/api/v1/storage/upload' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Api-Secret: YOUR_API_SECRET' \
  -F 'document=@/path/to/passport_front.jpg'

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "document": "https://storage.yativo.com/documents/abc123/passport_front.jpg"
  }
}

Use the returned document value in the selfie_image, image_front_file, proof_of_address_file, and similar fields below.

Individual KYC

Submit

POST https://kyc.yativo.com/api/individual-kyc/submit

This is a five-step data model submitted in one payload. All required fields must be present in a single request. A successful response means the submission passed validation and was accepted. It doesn’t mean the customer is approved. Verification runs afterwards, so treat the customer as pending until their status changes.

Step 1 — Personal details

Field	Type	Required	Notes
`customer_id`	string	✓	UUID from `POST /customer`
`first_name`	string	✓	Max 1024 chars
`last_name`	string	✓	Max 1024 chars
`middle_name`	string		Optional. Omit it, or send `null` or `""` if the customer has none
`email`	string	✓	Valid email address
`calling_code`	string	✓	Dial code, e.g. `"+1"`, `"+234"`. Must match `^\+\d{1,4}$`
`phone`	string	✓	Digits only, 8–15 characters
`birth_date`	string	✓	`YYYY-MM-DD`. The customer must be at least 18
`nationality`	string	✓	ISO 3166-1 alpha-2 from List Countries, e.g. `"US"`, `"NG"`, `"BR"`
`gender`	string	✓	`"male"` or `"female"`
`taxId`	string	✓	Tax identification number. Letters and digits only, up to 255 characters. `"123-45-6789"` is rejected; send `"123456789"`
`selfie_image`	file	✓	Selfie photo. PDF/JPG/JPEG/PNG/HEIC/TIF, 5 KB–30 MB
`bvn`	string	NG only	11-digit Bank Verification Number. Required when `nationality` or `residential_address.country` is `"NG"`
`nin`	string	NG only	11-digit National ID Number. Required when `nationality` or `residential_address.country` is `"NG"`
`usd_virtual_account`, `eur_virtual_account`, `gbp_virtual_account`, `native_endorsement`	boolean		Services to verify the customer for. See Virtual account flags

Step 2 — Residential address

Field	Type	Required	Notes
`residential_address.street_line_1`	string	✓	Max 256 chars
`residential_address.street_line_2`	string		Optional
`residential_address.city`	string	✓	Max 256 chars
`residential_address.state`	string	✓	`code` from List Subdivisions, e.g. `"CA"`. `"US-CA"` is also accepted
`residential_address.postal_code`	string	✓	Max 256 chars. Check the format with Get Postal Code Format
`residential_address.country`	string	✓	ISO 3166-1 alpha-2 from List Countries
`residential_address.proof_of_address_file`	file	✓	Utility bill, bank statement, etc. PDF/JPG/JPEG/PNG/HEIC/TIF

Step 3 — Identifying information

At least one government-issued ID document is required.

Field	Type	Required	Notes
`identifying_information[*].type`	string	✓	`type` from List ID Types for the issuing country
`identifying_information[*].issuing_country`	string	✓	ISO 3166-1 alpha-2 from List Countries
`identifying_information[*].number`	string	✓	Document number
`identifying_information[*].date_issued`	string	✓	`YYYY-MM-DD`, must be before today
`identifying_information[*].expiration_date`	string	✓	`YYYY-MM-DD`, must be after today
`identifying_information[*].image_front_file`	file	✓	PDF/JPG/JPEG/PNG
`identifying_information[*].image_back_file`	file		Required for cards with a back side

Step 4 — Risk and purpose

Field	Type	Required	Notes
`employment_status`	string	✓	See enum values
`most_recent_occupation_code`	string	✓	`code` from List Occupations. Must be a listed code
`expected_monthly_payments_usd`	string	✓	A value from List Expected Monthly Payment Ranges
`source_of_funds`	string	✓	See enum values and List Sources of Funds (Individual)
`account_purpose`	string	✓	See enum values and List Account Purposes (Individual)
`account_purpose_other`	string	If `account_purpose` is `"other"`	Description of the purpose
`acting_as_intermediary`	boolean		Whether the customer acts as intermediary for third parties
`annual_salary`	string		Declared annual income in whole currency units, digits only, up to 20 characters, e.g. `"9600000"`
`current_employer`	string		Up to 512 characters
`immigration_status`	string		`"Permanent U.S. Resident"`, `"Non-Permanent U.S. Resident"` or `"Non-Resident of U.S."`

The API accepts unknown values for employment_status, expected_monthly_payments_usd, source_of_funds and account_purpose, but verification fails later if they aren’t on the lists below. The 201 response lists them under warnings, along with other values verification is likely to reject. Check warnings and fix those fields with a partial update. KYB responses can include warnings too, for example when a country isn’t covered by one service. For these four fields, send the lookup key (PascalCase, such as ReceiveSalary, SelfEmployed or LessThan5K). The snake_case form (receive_salary, self_employed, 0_4999) is accepted too. Use the lookup endpoints in Reference lookups.

Step 5 — Supporting documents

Field	Type	Required	Notes
`uploaded_documents[*].type`	string	✓	Free-form, for example `proof_of_bank_account_ownership`, `proof_of_address` or `proof_of_funds`
`uploaded_documents[*].file`	file	✓	PDF/JPG/JPEG/PNG

Virtual account flags

Flag	Rule
`usd_virtual_account`, `eur_virtual_account`	Verify the customer for USD or EUR virtual accounts
`gbp_virtual_account`	Can be combined with any other flag. May add a KYC fee
`native_endorsement`	Can be combined with any other flag
`eurde_virtual_account`	Not available to customers created on or after 2 September 2026. When `true`, `usd_virtual_account` and `eur_virtual_account` must be `false`

Rejections to handle

Duplicate person (409). An individual submission is rejected if it matches a different customer on your account by bvn or nin; by the same ID document (same type, issuing_country and number); or by the same email, or phone with the same calling_code, when the first name, last name and date of birth (where both have one) also match. Nothing is saved, and the response names the existing customer:

{
  "success": false,
  "message": "KYC rejected: these details already belong to another customer on your account (c586066b-...). Use the existing customer instead of creating a new one.",
  "data": { "duplicate_of": ["c586066b-0f29-468f-b775-15483871a202"] }
}

Use the customer in duplicate_of. Resubmitting under the same customer_id isn’t a duplicate. Customers on other Yativo accounts are never matched. If two different people really share a detail, contact Yativo support to clear the match. Sandbox doesn’t run this check. Placeholder names (403). A submission is refused with 403 {"message": "Access denied."} if any name field contains test, yativo or admin (any case, anywhere in the value, so "Tester" matches), or an email contains test. This covers individual names, business_legal_name, business_trade_name and every associated person. The customer_id is then blocked permanently, even with corrected data. Use realistic names when testing. Country values. Send ISO alpha-2 codes. Common variants such as UK, usa or a full English name are converted automatically, but alpha-2 is the supported format.

KYC example request

curl -X POST 'https://kyc.yativo.com/api/individual-kyc/submit' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: kyc-ind-2026-001' \
  -d '{
    "customer_id": "c586066b-0f29-468f-b775-15483871a202",
    "first_name": "Alex",
    "last_name": "Smith",
    "email": "alex.smith@example.com",
    "calling_code": "+1",
    "phone": "5551234567",
    "gender": "male",
    "birth_date": "1990-01-15",
    "nationality": "US",
    "taxId": "998887766",
    "selfie_image": "https://storage.yativo.com/documents/abc/selfie.jpg",
    "residential_address": {
      "street_line_1": "123 Maple Street",
      "city": "Austin",
      "state": "TX",
      "postal_code": "78701",
      "country": "US",
      "proof_of_address_file": "https://storage.yativo.com/documents/abc/utility-bill.pdf"
    },
    "identifying_information": [
      {
        "type": "passport",
        "issuing_country": "US",
        "number": "P12345678",
        "date_issued": "2019-06-01",
        "expiration_date": "2029-06-01",
        "image_front_file": "https://storage.yativo.com/documents/abc/passport-front.jpg"
      }
    ],
    "employment_status": "employed",
    "most_recent_occupation_code": "151252",
    "expected_monthly_payments_usd": "0_4999",
    "source_of_funds": "salary",
    "account_purpose": "receive_salary",
    "acting_as_intermediary": false,
    "uploaded_documents": [
      {
        "type": "bank_statement",
        "file": "https://storage.yativo.com/documents/abc/bank-statement.pdf"
      }
    ]
  }'

const response = await fetch('https://kyc.yativo.com/api/individual-kyc/submit', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Idempotency-Key': `kyc-${customerId}-${Date.now()}`,
  },
  body: JSON.stringify({
    customer_id: customerId,
    first_name: 'Alex',
    last_name: 'Smith',
    email: 'alex.smith@example.com',
    calling_code: '+1',
    phone: '5551234567',
    gender: 'male',
    birth_date: '1990-01-15',
    nationality: 'US',
    taxId: '998887766',
    selfie_image: selfieUrl,          // URL from /storage/upload
    residential_address: {
      street_line_1: '123 Maple Street',
      city: 'Austin',
      state: 'TX',
      postal_code: '78701',
      country: 'US',
      proof_of_address_file: addressProofUrl,
    },
    identifying_information: [{
      type: 'passport',
      issuing_country: 'US',
      number: 'P12345678',
      date_issued: '2019-06-01',
      expiration_date: '2029-06-01',
      image_front_file: passportFrontUrl,
    }],
    employment_status: 'employed',
    most_recent_occupation_code: '151252',
    expected_monthly_payments_usd: '0_4999',
    source_of_funds: 'salary',
    account_purpose: 'receive_salary',
    acting_as_intermediary: false,
    uploaded_documents: [{ type: 'bank_statement', file: statementUrl }],
  }),
});

{
  "success": true,
  "message": "KYC submitted successfully.",
  "data": {
    "customer_id": "c586066b-0f29-468f-b775-15483871a202",
    "type": "individual",
    "status": "submitted",
    "first_name": "Alex",
    "last_name": "Smith",
    "email": "alex.smith@example.com",
    "submitted_at": "2026-10-20T10:00:00.000000Z"
  },
  "warnings": {
    "account_purpose": ["account_purpose is not one of the values from GET /api/individual-kyc/account-purposes; providers will reject it."]
  }
}

Business KYB

Submit

POST https://kyc.yativo.com/api/business-kyc/submit

Step 1 — Business basics

Field	Type	Required	Notes
`customer_id`	string	✓	UUID from `POST /customer` (must be `customer_type: "business"`)
`business_legal_name`	string	✓	Official registered legal name, max 255 chars
`business_trade_name`	string	✓	Trade / DBA name, max 255 chars
`business_description`	string	✓	What the business does, 140–5000 chars
`email`	string	✓	Business contact email
`business_type`	string	✓	`cooperative`, `corporation`, `llc`, `partnership`, `sole_prop`, `trust`, or `other`
`registration_number`	string	✓	Government registration / incorporation number, max 100 chars
`incorporation_date`	string	✓	`YYYY-MM-DD`, must be before today
`tax_id`	string	If no `identifying_information`	Business tax ID. Letters and digits only, up to 255 characters
`incorporation_country`	string		ISO 3166-1 alpha-2 from List Countries
`phone_calling_code`	string		Must match `^\+[1-9]\d{0,3}$`
`phone_number`	string		Digits only, 7–15 characters
`business_industry`	string		`code` from List Business Industries
`primary_website`	string	✓	Full URL
`is_dao`	boolean		Whether the business is a DAO
`statement_descriptor`	string		How the name appears on statements, max 22 chars

Step 2 — Addresses

Both registered_address and physical_address use the same structure:

Field	Type	Required	Notes
`street_line_1`	string	✓	Max 255 chars
`street_line_2`	string		Optional
`city`	string	✓	Max 100 chars
`state`	string	✓	`code` from List Subdivisions, e.g. `"CA"`. `"US-CA"` is also accepted
`postal_code`	string	✓	Must match the country’s format. See Get Postal Code Format
`country`	string	✓	ISO 3166-1 alpha-2 from List Countries
`proof_of_address_file`	file	✓	Required for both addresses

Step 3 — Associated persons

At least one person is required. Include all UBOs, directors, and authorized signers. People who own less than the ownership threshold are dropped from the submission, and the response’s warnings tell you who was dropped. Directors, signers and controllers (is_director, is_signer or has_control true) are always kept, whatever they own. The threshold is ownership_threshold (5–100, default 25). At least one person must meet it. A director, signer or controller doesn’t count towards this unless they own enough. The combined ownership_percentage of everyone with has_ownership: true can’t exceed 100.

Field	Type	Required	Notes
`first_name`	string	✓	Max 100 chars
`last_name`	string	✓	Max 100 chars
`birth_date`	string	✓	`YYYY-MM-DD`. The person must be at least 18
`nationality`	string	✓	ISO 3166-1 alpha-2 from List Countries
`email`	string	✓	Personal email
`phone`	string		Digits only, 7–15 characters
`tax_id`	string		Personal tax ID. Letters and digits only, up to 255 characters
`annual_salary`	string		Digits only, up to 20 characters
`title`	string		E.g. `"CEO"`, `"Director"`
`ownership_percentage`	number	✓	0–100
`relationship_established_at`	string		`YYYY-MM-DD`, must not be in the future
`residential_address`	object	✓	Same structure as Step 2, including `proof_of_address_file`
`identifying_information`	array	✓	See below
`has_ownership`	boolean		Has ownership stake
`has_control`	boolean		Has operational control
`is_signer`	boolean		Authorized signer
`is_director`	boolean		Director. Send all four flags for every person. Each accepts `true`/`false`, `1`/`0` or `"1"`/`"0"`. If `has_ownership` is left out and `ownership_percentage` is above 0, the person is treated as an owner

Each person’s identifying_information needs at least one ID that isn’t a tax ID, such as a passport or national ID. Associated persons use image_front and image_back, not the _file names used in individual KYC:

Field	Required	Notes
`type`	✓	ID type, e.g. `passport`, `national_id`, `drivers_license` or `tax_id`
`number`	✓	For `tax_id`, letters and digits only
`issuing_country`	Send on every photo ID	Missing values come back in `warnings`. ISO 3166-1 alpha-2 from List Countries
`expiration`		`YYYY-MM-DD`. An expired document is rejected with `422`
`date_issued`		`YYYY-MM-DD`
`image_front`	✓	File
`image_back`	Except `passport` and `tax_id`	File

For a Naira account in the business’s name, add a bvn entry (11-digit number, no image) for a Nigerian associated person. See naira in What each endorsement needs.

Step 4 — Risk and purpose

Field	Type	Required	Notes
`account_purpose`	string	✓	Business values only. See List Account Purposes (Business)
`account_purpose_other`	string	If `account_purpose` is `"other"`
`source_of_funds`	string	✓	Business values only. See List Sources of Funds (Business)
`high_risk_activities`	array	✓	See enum values. Use `["none_of_the_above"]` if none apply
`high_risk_activities_explanation`	string	If anything other than `none_of_the_above` is listed	Always send one in that case
`conducts_money_services`	boolean
`conducts_money_services_description`	string	If `conducts_money_services` is `true`
`compliance_screening_explanation`	string	If `conducts_money_services` is `true`
`estimated_annual_revenue_usd`	string
`expected_monthly_payments_usd`	integer	✓	Expected monthly volume in USD, at least 1
`operates_in_prohibited_countries`	string		`"yes"` or `"no"`
`ownership_threshold`	integer		Ownership threshold for associated persons, 5–100. Default 25
`has_material_intermediary_ownership`	boolean

Step 5 — Regulated activity

Field	Type	Notes
`pep_status`	boolean	Required. Whether any associated person is a politically exposed person
`third_party_msb_payments`	boolean	Required. Whether the business makes payments for third-party money services businesses
`regulated_activity.regulated_activities_description`	string	Optional
`regulated_activity.primary_regulatory_authority_country`	string	ISO 3166-1 alpha-2 from List Countries
`regulated_activity.primary_regulatory_authority_name`	string
`regulated_activity.license_number`	string

Step 6 — Business documents

At least one document is required.

Field	Type	Required	Notes
`documents[*].purpose`	string	✓	`business_registration`, `proof_of_address`, `tax_documents`, `compliance_documents`, `financial_statements`, `certificate_of_good_standing`, `portfolio_statement` or `board_minutes`
`documents[*].description`	string	✓	Human-readable description
`documents[*].file`	file	✓	File attachment

Step 7 — Business identifying information (optional)

Business-level ID documents (e.g. business licence).

Field	Type	Notes
`identifying_information[*].type`	string
`identifying_information[*].issuing_country`	string	ISO 3166-1 alpha-2 from List Countries
`identifying_information[*].number`	string
`identifying_information[*].description`	string
`identifying_information[*].expiration`	string	`YYYY-MM-DD`, after today
`identifying_information[*].image_front`	file	Required when `type` is `tax_id`
`identifying_information[*].image_back`	file

Step 8 — Extra documents

extra_documents is an array of { "type": "...", "file": ... }. These are required:

`type`	When
`shareholding_structure`	Always. A chart of the business’s ownership
`board_resolution`	When an associated person has `is_signer: true` and `is_director: false`

Optional business profile

Describe the business’s activity in three nested objects, not as top-level fields. All are optional. A value outside the allowed list doesn’t block the submission, but it comes back in warnings. extra_business_info

Field	Notes
`meeting_mode`, `primary_account_purpose`	Strings, up to 255 characters
`industry_vertical`	Up to 255 characters. Send a supported vertical exactly as written, for example `"Ecommerce - Consumer Electronics"`. Other values are mapped to the closest one
`business_description`	140–5000 characters
`obo_usage`	`"yes"` or `"no"`: whether the business moves money on behalf of others
`monthly_volume_usd`, `avg_transaction_usd`, `max_transaction_usd`	Numbers. `avg_transaction_usd` can’t exceed `max_transaction_usd`
`sender_geographies`	Any of `Africa`, `Europe`, `North America`, `South America`, `Asia`

collections_data

Field	Notes
`sender_industries`	Any of `E-commerce`, `Wholesale`, `Retail`, `Logistics`, `Manufacturing`, `Consulting`, `Others`
`sender_types`	`individuals`, `business`, `businesses` or `both`
`top_5_senders`	Up to 5 names
`incoming_from_fintech_wallets`, `incoming_fintech_wallet_details`	Boolean, and details up to 1000 characters
`collection_currencies`	Three-letter codes from List Transaction Currencies
`current_collection_provider`, `reason_for_switching_collection`	Strings
`expected_monthly_disbursement_usd`, `avg_transaction_amount_collection`, `max_transaction_amount_collection`	Numbers

payouts_data

Field	Notes
`payout_primary_purpose`	Up to 255 characters
`beneficiary_geographies`	Two-letter codes from List Transaction Countries with `status: enabled`
`beneficiary_industries`	Strings
`beneficiary_types`	`individual`, `individuals`, `business` or `both`
`top_5_beneficiaries`	Up to 5 names
`primary_payout_method`	`ach`, `wire`, `sepa`, `swift`, `local_transfer`, `mobile_money` or `crypto`
`payout_currencies`, `current_payout_provider`, `reason_for_switching_payout`	Currency codes and strings

"extra_business_info": {
  "meeting_mode": "video_call",
  "industry_vertical": "General Industries - Trade & Wholesale of General Goods",
  "obo_usage": "no",
  "monthly_volume_usd": 100000,
  "avg_transaction_usd": 10000,
  "max_transaction_usd": 50000,
  "sender_geographies": ["North America", "Europe"]
},
"collections_data": {
  "sender_industries": ["Retail", "E-commerce"],
  "sender_types": "business",
  "collection_currencies": ["USD", "EUR"]
},
"payouts_data": {
  "beneficiary_geographies": ["US", "GB"],
  "beneficiary_types": "business",
  "primary_payout_method": "swift",
  "payout_currencies": ["USD", "EUR"]
}

KYB also accepts the virtual account flags.

KYB example request

curl -X POST 'https://kyc.yativo.com/api/business-kyc/submit' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: kyb-acme-2026-001' \
  -d '{
    "customer_id": "d47f8a2b-1c3e-4f5a-9b8c-7d6e5f4a3b2c",
    "business_legal_name": "Acme Payments LLC",
    "business_trade_name": "Acme Pay",
    "business_description": "Acme Pay builds invoicing and checkout software for small online retailers in the United States and Latin America, and collects card and bank payments for them.",
    "email": "compliance@acmepay.com",
    "business_type": "llc",
    "registration_number": "LLC-2018-00987",
    "incorporation_date": "2018-03-12",
    "incorporation_country": "US",
    "tax_id": "471234567",
    "phone_calling_code": "+1",
    "phone_number": "3055551234",
    "primary_website": "https://acmepay.com",
    "registered_address": {
      "street_line_1": "100 Brickell Ave",
      "city": "Miami",
      "state": "FL",
      "postal_code": "33131",
      "country": "US",
      "proof_of_address_file": "https://storage.yativo.com/documents/abc/registered-address.pdf"
    },
    "physical_address": {
      "street_line_1": "100 Brickell Ave",
      "city": "Miami",
      "state": "FL",
      "postal_code": "33131",
      "country": "US",
      "proof_of_address_file": "https://storage.yativo.com/documents/abc/lease.pdf"
    },
    "associated_persons": [
      {
        "first_name": "Jane",
        "last_name": "Doe",
        "birth_date": "1978-07-22",
        "nationality": "US",
        "email": "jane.doe@acmepay.com",
        "title": "CEO",
        "ownership_percentage": 60,
        "relationship_established_at": "2018-03-12",
        "residential_address": {
          "street_line_1": "456 Coral Way",
          "city": "Miami",
          "state": "FL",
          "postal_code": "33133",
          "country": "US",
          "proof_of_address_file": "https://storage.yativo.com/documents/abc/jane-utility-bill.pdf"
        },
        "identifying_information": [
          {
            "type": "passport",
            "issuing_country": "US",
            "number": "P87654321",
            "expiration": "2030-01-10",
            "image_front": "https://storage.yativo.com/documents/abc/jane-passport.jpg"
          },
          {
            "type": "tax_id",
            "issuing_country": "US",
            "number": "123456789"
          }
        ],
        "has_ownership": true,
        "has_control": true,
        "is_signer": true,
        "is_director": true
      }
    ],
    "account_purpose": "receive_payments_for_goods_and_services",
    "source_of_funds": "SalesOfGoodsAndServices",
    "expected_monthly_payments_usd": 50000,
    "high_risk_activities": ["none_of_the_above"],
    "conducts_money_services": false,
    "pep_status": false,
    "third_party_msb_payments": false,
    "documents": [
      {
        "purpose": "business_registration",
        "description": "Certificate of Incorporation",
        "file": "https://storage.yativo.com/documents/abc/certificate.pdf"
      },
      {
        "purpose": "tax_documents",
        "description": "EIN confirmation letter",
        "file": "https://storage.yativo.com/documents/abc/ein.pdf"
      }
    ],
    "extra_documents": [
      {
        "type": "shareholding_structure",
        "file": "https://storage.yativo.com/documents/abc/cap-table.pdf"
      }
    ],
    "usd_virtual_account": true
  }'

{
  "success": true,
  "message": "All data submitted successfully.",
  "business_data": {
    "customer_id": "d47f8a2b-1c3e-4f5a-9b8c-7d6e5f4a3b2c",
    "business_legal_name": "Acme Payments LLC",
    "status": "submitted"
  }
}

Track verification with endorsements

A customer’s KYC or KYB result is only available through their endorsements. Each endorsement is one service, such as base, sepa or cobo_pobo, with its own status. A customer can be approved for one service and still be under review for another, so there’s no single overall status to check. Don’t rely on customer_kyc_status or is_va_approved to decide what a customer can use. Check the endorsement for the service you need.

Listen for `endorsement.updated`

Yativo sends endorsement.updated whenever any of a customer’s endorsements changes. endorsements is the customer’s full current list:

{
  "event.type": "endorsement.updated",
  "payload": {
    "endorsements": [
      { "service": "base", "status": "approved" },
      { "service": "sepa", "status": "under_review" }
    ],
    "customer_id": "c586066b-0f29-468f-b775-15483871a202",
    "customer": { "customer_id": "c586066b-0f29-468f-b775-15483871a202", "...": "..." }
  }
}

Store the list and compare it with your copy to see what changed.

Read the current endorsements

To check on demand, for example when your server starts up or you missed a webhook, read the customer’s endorsement list:

GET https://api.yativo.com/api/v1/customer/{customer_id}

curl -X GET 'https://api.yativo.com/api/v1/customer/c586066b-0f29-468f-b775-15483871a202' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Api-Secret: YOUR_API_SECRET'

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "customer_id": "c586066b-0f29-468f-b775-15483871a202",
    "customer_name": "Alex Smith",
    "endorsement": [
      {
        "service": "Base",
        "status": "approved",
        "hosted_kyc_url": null,
        "errors": null,
        "requirements_due": null,
        "future_requirements_due": null,
        "metadata": null,
        "updated": "Oct 20, 2026 10:15"
      },
      {
        "service": "Sepa",
        "status": "rejected",
        "hosted_kyc_url": "https://kyc.yativo.com/endorsement/sepa/c586066b-0f29-468f-b775-15483871a202",
        "errors": ["The document or its details could not be read clearly."],
        "requirements_due": ["proof_of_address"],
        "future_requirements_due": null,
        "metadata": null,
        "updated": "Oct 20, 2026 10:20"
      }
    ]
  }
}

Field	Description
`service`	The endorsement, title-cased with spaces, such as `"Faster payments"`. Compare it with the lowercase, underscored name, such as `faster_payments`
`status`	See Endorsement statuses
`hosted_kyc_url`	A page where the customer can complete or fix verification for this service, when one is needed
`errors`	Why verification failed, when it has
`requirements_due`, `future_requirements_due`	Information still needed now, and information that will be needed later
`metadata`	Extra details, such as `last_resubmission` after a resubmission

What each endorsement needs

You don’t request endorsements directly. Which ones are attempted depends on your submission, mainly the virtual account flags and whether the data is complete enough. A missing field or document doesn’t fail the submission. It leaves that endorsement below approved until you fix it.

Endorsement	Attempted when	What decides approval
`base`, `sepa`	Always	Approval happens on a hosted onboarding link sent after your submission
`spei`	Always	Approved automatically: individuals once an ID front image and `selfie_image` are on file, businesses once KYB is submitted
`eurde`	`eurde_virtual_account: true`	Full name, email, phone, a valid `birth_date` or `incorporation_date`, registration number or tax ID, and a complete address
`faster_payments`	Individuals: always. Businesses: only with `gbp_virtual_account: true`	The fullest profile: basics, full address, occupation or industry, source of funds, account purpose, a photo ID (individual) or a `business_registration` document (business), and proof of address
`cobo_pobo`	Always	A registration or incorporation document, proof of address on the registered or physical address, a phone with calling code, and an associated person with a photo ID
`native`	Always	Name, tax ID, address and, for businesses, each associated person’s name and `ownership_percentage`
`asian`	Individuals: only with an ID front image and a selfie	The customer’s country (or the business’s incorporation country) must be supported. Then email, name and address (individual), or legal name, registration number, incorporation date, phone and address (business)
`brazil`	Always	Individuals: tax ID, full residential address, ID front image and selfie. Businesses: an associated person with a photo ID, plus an incorporation document and a tax ID document in `documents` or `extra_documents`
`usd_latam`, `eur_latam`	Once `brazil` is approved	Nothing extra
`virtual_card`	With an ID front image (not needed for tax-ID types such as `bvn` or `nin`)	Cardholder name, date of birth, ID number, email, phone and address. For a business, the associated person with the highest `ownership_percentage` is the cardholder
`naira`	A Nigerian person with a BVN: individuals with `bvn`, businesses registered in Nigeria or with a Nigerian associated person who has a `bvn` entry in `identifying_information`	The BVN must match a real record. The person also needs an email, a phone and a date of birth showing they’re 18 or older. For a business, the account opens in the company’s name

Three endorsements reject outright instead of waiting in under_review:

cobo_pobo: no identifiable registration document, or a representative with no ID document
brazil: any of the items listed above is missing
asian: the country isn’t supported. This can also decline an endorsement that was approved before

BVN. Any BVN you submit, for an individual or an associated person, must be 11 digits and match a real record. If it doesn’t, every endorsement is declined, spei included, with errors: ["Unable to verify customer information"].

Endorsements that failed to start

If an endorsement can’t be submitted at all, because a required document or field is missing or invalid, it stays at not_started (declined for virtual_card and naira) and errors says why, for example ["Missing required documents: ID document front image, selfie"]. Fix the data with a partial update or a full resubmission, and the endorsement is submitted again automatically. errors, requirements_due and future_requirements_due are always arrays of readable messages, and empty when there are none.

Which endorsement a service needs

To use	The customer needs an approved
A virtual account	The endorsement for that currency. `GET /business/virtual-account/currencies-and-endorsements` returns the endorsement each currency needs
A payout method	The endorsement for that method. A payout without it fails with `This customer isn't enabled for this payout method yet.`
Corporate cards	`cobo_pobo`
Virtual cards	`virtual_card`

cURL

curl -X GET 'https://api.yativo.com/api/v1/business/virtual-account/currencies-and-endorsements' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Api-Secret: YOUR_API_SECRET'

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": [
    { "currency": "USD", "endorsement": "base" },
    { "currency": "EUR", "endorsement": "sepa" },
    { "currency": "MXN", "endorsement": "spei" }
  ]
}

Update a KYC submission

Use this endpoint to correct information or provide missing documents after a rejection.

PUT /customer/kyc/update

Send only the fields you need to correct. customer_id is always required.

curl -X PUT 'https://api.yativo.com/api/v1/customer/kyc/update' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Api-Secret: YOUR_API_SECRET' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: kyc-update-2026-002' \
  -d '{
    "customer_id": "c586066b-0f29-468f-b775-15483871a202",
    "selfie_image": "https://storage.yativo.com/documents/abc/selfie-v2.jpg",
    "identifying_information": [
      {
        "type": "passport",
        "issuing_country": "US",
        "number": "P12345678",
        "date_issued": "2019-06-01",
        "expiration_date": "2029-06-01",
        "image_front_file": "https://storage.yativo.com/documents/abc/passport-front-hd.jpg"
      }
    ]
  }'

Partial update on the KYC platform

To correct a few fields on a submission, send only those fields to the KYC platform:

PATCH https://kyc.yativo.com/api/individual-kyc/{customer_id}
PATCH https://kyc.yativo.com/api/business-kyc/{customer_id}

Fields use the same names and rules as the submit endpoints. On these endpoints, state and postal_code are checked against the country’s subdivision and postal code formats. An empty body returns 400 No fields provided., and a customer with no submission returns 404. Endorsements that failed to start are submitted again automatically once the update is saved. The response lists them in resubmitted_endorsements, for example ["asian"], and each shows under_review while it runs.

cURL

curl -X PATCH 'https://kyc.yativo.com/api/individual-kyc/c586066b-0f29-468f-b775-15483871a202' \
  -H 'Content-Type: application/json' \
  -d '{
    "residential_address": {
      "street_line_1": "742 Evergreen Terrace",
      "city": "Springfield",
      "state": "IL",
      "postal_code": "62704",
      "country": "US"
    }
  }'

Resubmit one endorsement

After a customer updates their ID document or selfie, re-run verification for one endorsement without touching the others:

POST https://api.yativo.com/api/v1/customer/kyc/resubmit/{customer_id}/{endorsement}

endorsement is one of base, sepa, spei, faster_payments, naira, virtual_card, asian or brazil. This works for individual customers only. For a business, or for cobo_pobo, native, eurde, usd_latam or eur_latam, use the KYC platform endpoint below.

cURL

curl -X POST 'https://api.yativo.com/api/v1/customer/kyc/resubmit/c586066b-0f29-468f-b775-15483871a202/faster_payments' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Api-Secret: YOUR_API_SECRET' \
  -H 'Idempotency-Key: resubmit-fp-001'

Success

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": { "message": "KYC resubmission for \"faster_payments\" queued." }
}

A 200 means the resubmission was queued, not that verification finished. Watch for endorsement.updated, or check the endorsement’s status with GET /customer/{customer_id}. Its metadata.last_resubmission shows whether the resubmission itself could be processed:

`last_resubmission.message` when `success` is `false`	Meaning
`Identity document and selfie are required before resubmission.`	Upload both, then retry
`Verification has not been started for this customer yet.`	The customer must complete initial verification for this endorsement first
`Submission failed.`	A temporary error. Safe to retry

Status	`data.error`	Cause
`404`	`Customer not found`	No customer with that ID on your account
`404`	`Individual KYC submission not found`	The customer has no KYC data yet
`422`	`This endpoint only supports individual customers`	The customer is a business
`422`	`Unknown endorsement "...". Valid endorsements: ...`	`endorsement` isn’t supported

service in the customer’s endorsement list is title-cased, for example "Faster payments". Compare it with the lowercase form you sent.

On the KYC platform (individual or business)

POST https://kyc.yativo.com/api/kyc/endorsements/{customer_id}/{service}/resubmit

Works for individual and business customers, for any endorsement: base, sepa, eurde, spei, asian, virtual_card, naira, cobo_pobo, faster_payments, native, brazil, usd_latam or eur_latam. The endorsement moves to under_review right away and its errors are cleared. If the stored data can’t be submitted, it returns to its previous status and errors.resubmission_failed says why.

Status	Meaning
`202`	Queued. `data.status` is `under_review`
`403`	Resubmit protection is on for your account and the `X-Resubmit-Token` header (or `token` body field) is missing or wrong
`404`	No stored submission for this customer
`409`	The endorsement is already approved
`422`	Unknown endorsement

You can call it 30 times a minute.

Service endorsements

Each endorsement unlocks one service. Its status is the verification result for that service.

Service	Description
`base`	USD base payment access
`sepa`	European SEPA transfers
`spei`	Mexico SPEI transfers
`brazil`	Brazilian payment rails
`eurde`	EUR/DE virtual accounts
`usd_latam`	USD Latin America transfers
`eur_latam`	EUR Latin America transfers
`virtual_card`	Virtual card issuance
`faster_payments`	UK Faster Payments
`naira`	Nigerian naira accounts
`asian`	Asian region payments
`native`	Native payment rails
`cobo_pobo`	Collection / payment-on-behalf-of. Also required for corporate cards

Endorsement statuses

Status	Description
`not_started`	Not yet initiated
`submitted`	Received, not yet reviewed
`pending`	Awaiting review
`under_review`	Review in progress
`approved`	The customer can use this service
`rejected`	Rejected. Check `errors` and `requirements_due`, fix them, then resubmit
`declined`	Declined

Only approved means the service is available. Treat every other status as not yet usable.

Regenerate an endorsement link

If an endorsement link has expired, regenerate it and share the new URL with the customer:

GET https://kyc.yativo.com/api/kyc/regenerate/{customer_id}/{service}

curl -X GET 'https://kyc.yativo.com/api/kyc/regenerate/c586066b-0f29-468f-b775-15483871a202/sepa' \

{
  "success": true,
  "message": "Endorsement link regenerated successfully",
  "data": {
    "service": "sepa",
    "customer_id": "c586066b-0f29-468f-b775-15483871a202",
    "link": "https://kyc.yativo.com/endorsement/sepa/c586066b-0f29-468f-b775-15483871a202?token=abc123"
  }
}

Reference lookups

The KYC platform serves the lists your form needs. Prefix each path with https://kyc.yativo.com/api:

Endpoint	Returns
`GET /countries`	Supported countries
`GET /subdivisions/{countryCode}`	States or provinces, with the `code` to send as `state`
`GET /postal-codes/{countryCode}`	The country’s postal code format
`GET /identification-types/{countryCode}`	ID `type` values accepted for that country
`GET /occupations`	Occupation codes
`GET /business-industries`	Business industries
`GET /transaction-currencies`, `GET /transaction-countries`	Values for `collection_currencies` and `beneficiary_geographies`
`GET /individual-kyc/account-purposes`, `GET /individual-kyc/source-of-funds`	Individual KYC values
`GET /business-kyc/account-purposes`, `GET /business-kyc/source-of-funds`	KYB values. These differ from the individual lists
`GET /individual-kyc/expected-monthly-payments-usd`	`expected_monthly_payments_usd` values

The same occupation and country data is also available on the main API:

Occupation codes

Get the full list of valid occupation codes for most_recent_occupation_code:

GET /auth/occupation-codes

curl -X GET 'https://api.yativo.com/api/v1/auth/occupation-codes' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Api-Secret: YOUR_API_SECRET'

{
  "status": "success",
  "status_code": 200,
  "data": [
    { "display_name": "Software developer", "code": "151252" },
    { "display_name": "Accountant and auditor", "code": "132011" },
    { "display_name": "Financial manager", "code": "113031" },
    { "display_name": "Registered nurse", "code": "291141" }
  ]
}

Supported countries

Get the list of countries supported for customer registration and verification:

GET /auth/verification-locations

curl -X GET 'https://api.yativo.com/api/v1/auth/verification-locations' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'X-Api-Secret: YOUR_API_SECRET'

{
  "status": "success",
  "status_code": 200,
  "data": [
    { "country": "United States", "code": "US" },
    { "country": "Brazil", "code": "BR" },
    { "country": "Nigeria", "code": "NG" },
    { "country": "Mexico", "code": "MX" },
    { "country": "Colombia", "code": "CO" }
  ]
}

Enum reference values

`employment_status`

API value	Description
`employed`	Employed
`exempt`	Exempt
`homemaker`	Homemaker
`retired`	Retired
`self_employed`	Self-Employed
`student`	Student
`unemployed`	Unemployed

`expected_monthly_payments_usd`

API value	Range
`0_4999`	Less than $5,000
`5000_9999`	$5,000 – $9,999
`10000_49999`	$10,000 – $49,999
`50000_plus`	$50,000 or more

`source_of_funds`

API value	Description
`company_funds`	Company Funds
`ecommerce_reseller`	Ecommerce Reseller
`gambling_proceeds`	Gambling Proceeds
`gifts`	Gifts
`government_benefits`	Government Benefits
`inheritance`	Inheritance
`investments_loans`	Investments / Loans
`pension_retirement`	Pension / Retirement
`salary`	Salary
`sale_of_assets_real_estate`	Sale of Assets or Real Estate
`savings`	Savings
`someone_elses_funds`	Someone Else’s Funds

`account_purpose`

API value	Description
`charitable_donations`	Charitable Donations
`ecommerce_retail_payments`	Ecommerce / Retail Payments
`investment_purposes`	Investment Purposes
`operating_a_company`	Operating a Company
`other`	Other (requires `account_purpose_other`)
`payments_to_friends_or_family_abroad`	Payments to Friends or Family Abroad
`personal_or_living_expenses`	Personal / Living Expenses
`protect_wealth`	Protect Wealth
`purchase_goods_and_services`	Purchase Goods and Services
`receive_payment_for_freelancing`	Receive Payment for Freelancing
`receive_salary`	Receive Salary

`high_risk_activities` (KYB)

API value	Description
`adult_entertainment`	Adult entertainment
`gambling`	Gambling
`hold_client_funds`	Holding client funds
`investment_services`	Investment services
`lending_banking`	Lending or banking
`marijuana_or_related_services`	Marijuana-related services
`money_services`	Money services
`operate_foreign_exchange_virtual_currencies_brokerage_otc`	Foreign exchange / crypto brokerage / OTC
`pharmaceuticals`	Pharmaceuticals
`precious_metals_precious_stones_jewelry`	Precious metals / stones / jewelry
`safe_deposit_box_rentals`	Safe deposit box rentals
`third_party_payment_processing`	Third-party payment processing
`nicotine_tobacco_or_related_services`	Nicotine, tobacco or related services
`weapons_firearms_and_explosives`	Weapons / firearms / explosives
`none_of_the_above`	None of the above

The source_of_funds and account_purpose lists above are for individual KYC. KYB uses its own lists.

KYB `account_purpose`

charitable_donations, ecommerce_retail_payments, investment_purposes, other, payments_to_friends_or_family_abroad, payroll, personal_or_living_expenses, protect_wealth, purchase_goods_and_services, receive_payments_for_goods_and_services, tax_optimization, third_party_money_transmission, treasury_management

KYB `source_of_funds`

KYB source_of_funds values are PascalCase: BusinessLoans, Grants, InterCompanyFunds, InvestmentProceeds, LegalSettlement, OwnersCapital, PensionRetirement, SaleOfAssets, SalesOfGoodsAndServices, ThirdPartyFunds, TreasuryReserves

`business_type` (KYB)

cooperative, corporation, llc, partnership, sole_prop, trust, other

ID types by country

The accepted type values under identifying_information depend on the issuing country. Get the full list for a country from List ID Types. Common types available globally:

Type	Description
`passport`	Passport
`national_id`	National ID card
`other`	Other government-issued ID

Countries also accept country-specific types, for example:

Country	Extra types available
`NG` (Nigeria)	`tin`, `nin`, `bvn`
`US` (United States)	`ssn`, `itin`
`BR` (Brazil)	`cpf`
`GB` (United Kingdom)	`nino`, `utr`
`IN` (India)	`pan`
`MX` (Mexico)	`rfc`, `curp`, `ine`
`DE` (Germany)	`steuer_id`
`AE` (UAE)	`emirates_id`

Use GET /auth/verification-locations to check which countries are supported, and consult the full ID type reference in the API reference section.

Webhooks

KYC and KYB results arrive as endorsement.updated events. There’s no separate KYC status event. See Track verification with endorsements.

Error handling

The KYC platform returns validation errors in its own shape, with 422:

{
  "success": false,
  "message": "Validation error.",
  "validation_errors": {
    "residential_address.postal_code": ["The residential address postal code field is required."]
  },
  "field_labels": {
    "residential_address.postal_code": "Residential address › Postal code"
  },
  "field_hints": {
    "residential_address.postal_code": "Call GET /postal-codes/{countryCode} for the expected format."
  }
}

validation_errors lists every failing field. field_labels gives a readable name for each, and field_hints gives advice where available. Show both next to the matching form field. KYB returns "message": "Validation failed." and may add notices about associated persons below the ownership threshold.

Common errors and fixes

Error	Fix
`customer_id does not exist`	Create the customer first with `POST /customer`
`nationality must be 2 characters`	Use ISO 3166-1 alpha-2 (e.g. `"US"`, `"NG"`)
`birth_date` must be a date before or equal to 18 years ago	The person must be at least 18
`Tax ID must contain only letters and digits, up to 255 characters.`	Remove dashes, spaces and dots
File must not be smaller than 5 KB or greater than 30 MB	Resize the file
`Business with the provided Customer_ID not found.` (`404`)	Create the customer first with `POST /customer`
`Upload a shareholding structure chart.`	Add an `extra_documents` entry with `type: "shareholding_structure"`
`At least one non-tax-ID identifying document (e.g. passport, national ID) is required.`	Add a passport or national ID for that associated person
`expiration_date must be a date after today`	ID document must not be expired
`bvn is required`	Required for Nigerian nationals and residents. Exactly 11 digits
`nin is required`	Required for Nigerian nationals and residents. Exactly 11 digits
`calling_code is invalid`	Must be `+` followed by 1–4 digits, e.g. `"+1"`, `"+234"`
`identifying_information is required`	At least one ID document must be included
`documents is required`	KYB requires at least one business document

Go-live checklist

Sandbox is forgiving. Production isn’t. Before switching:

Every request, lookups included, goes to the production host, read from config rather than hardcoded.
Lookup values cached from sandbox are fetched again from production, or fetched live.
No sandbox test values are hardcoded. See Sandbox KYC.
Nigerian customers send their own bvn and nin, and their name and date of birth match their BVN record.
No real customer has a placeholder name or email.
You handle 409 duplicates by reusing duplicate_of, show 422 errors field by field, and treat 403 Access denied. as final for that customer_id.
A 200 or 201 is shown as “submitted, pending review”, never “approved”.
You’ve submitted one real individual (and one real business, if you onboard businesses) on production and seen the endorsement results end to end.

Implementation notes

KYC review typically completes within 24 hours. Complex cases may take longer.
Use Idempotency-Key on all POST and PUT requests to prevent duplicate submissions.
Files can be passed as hosted URLs (from POST /storage/upload) or base64-encoded strings — both are accepted.
For Nigerian nationals or residents (nationality or residential_address.country is "NG"), bvn and nin are mandatory regardless of which ID type is provided.
state accepts "US-CA" and "CA". Send the bare code from the subdivisions lookup.
Use the PATCH endpoints in Update a KYC submission for small corrections instead of resubmitting everything.

​Environments

​Integration approaches

​Build your form with the lookup endpoints

​Verification flow

​Upload documents

​Individual KYC

​Submit

​Step 1 — Personal details

​Step 2 — Residential address

​Step 3 — Identifying information

​Step 4 — Risk and purpose

​Step 5 — Supporting documents

​Virtual account flags

​Rejections to handle

​KYC example request

​Business KYB

​Submit

​Step 1 — Business basics

​Step 2 — Addresses

​Step 3 — Associated persons

​Step 4 — Risk and purpose

​Step 5 — Regulated activity

​Step 6 — Business documents

​Step 7 — Business identifying information (optional)

​Step 8 — Extra documents

​Optional business profile

​KYB example request

​Track verification with endorsements

​Listen for endorsement.updated

​Read the current endorsements

​What each endorsement needs

​Endorsements that failed to start

​Which endorsement a service needs

​Update a KYC submission

​Partial update on the KYC platform

​Resubmit one endorsement

​On the KYC platform (individual or business)

​Service endorsements

​Endorsement statuses

​Regenerate an endorsement link

​Reference lookups

​Occupation codes

​Supported countries

​Enum reference values

​employment_status

​expected_monthly_payments_usd

​source_of_funds

​account_purpose

​high_risk_activities (KYB)

​KYB account_purpose

​KYB source_of_funds

​business_type (KYB)

​ID types by country

​Webhooks

​Error handling

​Common errors and fixes

​Go-live checklist

​Implementation notes

Environments

Integration approaches

Build your form with the lookup endpoints

Verification flow

Upload documents

Individual KYC

Submit

Step 1 — Personal details

Step 2 — Residential address

Step 3 — Identifying information

Step 4 — Risk and purpose

Step 5 — Supporting documents

Virtual account flags

Rejections to handle

KYC example request

Business KYB

Submit

Step 1 — Business basics

Step 2 — Addresses

Step 3 — Associated persons

Step 4 — Risk and purpose

Step 5 — Regulated activity

Step 6 — Business documents

Step 7 — Business identifying information (optional)

Step 8 — Extra documents

Optional business profile

KYB example request

Track verification with endorsements

Listen for `endorsement.updated`

Read the current endorsements

What each endorsement needs

Endorsements that failed to start

Which endorsement a service needs

Update a KYC submission

Partial update on the KYC platform

Resubmit one endorsement

On the KYC platform (individual or business)

Service endorsements

Endorsement statuses

Regenerate an endorsement link

Reference lookups

Occupation codes

Supported countries

Enum reference values

`employment_status`

`expected_monthly_payments_usd`

`source_of_funds`

`account_purpose`

`high_risk_activities` (KYB)

KYB `account_purpose`

KYB `source_of_funds`

`business_type` (KYB)

ID types by country

Webhooks

Error handling

Common errors and fixes

Go-live checklist

Implementation notes