Kyc verification

Get customer verified address

Retrieve the verified address on file for a customer.

GET
/api/v2/customers/{customerId}/kyc/address

Returns the address on file for a customer. For individual customers, this is extracted from KYC verification data (proof of address). For corporate customers, this is the stored business address. This address is automatically used when creating a first-party withdrawal bank without providing an address.

Authorization

bearerAuth
AuthorizationBearer <token>

Organization API key obtained on Settings > API Keys page in Compose UI.

In: header

Path Parameters

customerId*string

The unique identifier of the customer

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl 'https://compose.finance/api/v2/customers/{customerId}/kyc/address' \  -H 'Authorization: Bearer YOUR_API_KEY'
{
  "addressLine1": "Friedrichstrasse 123",
  "city": "Berlin",
  "country": "DE",
  "postalCode": "10117"
}
{
  "error": "Not available for AUD-only customers"
}
{
  "error": "Unauthorized - Invalid or missing API key or session"
}

{
  "error": "Customer KYC verification must be completed before retrieving address"
}

{
  "error": "Customer not found"
}

{
  "error": "Rate limit exceeded. Please try again later."
}

{
  "error": "Internal server error"
}

Import a customer with a share token POST

Creates a customer from a share token generated in your Sumsub account. Verification steps the customer already completed carry over; the customer finishes the rest through the returned `kycFlowLink`. A selfie carries over only when your Sumsub level records it as a short video; otherwise the customer records one through the link. Share tokens are single-use. `idempotencyKey` is required unless `dryRun` is set; reuse it on retries so they return the same customer. If a retry under a new `idempotencyKey` finds the customer its first request created, it gets `409 DUPLICATE_CUSTOMER` with `existingCustomerId`. If that earlier import isn't finished, the request finishes it and returns `201` for that customer, or `503` with `existingCustomerId`. Set `dryRun` to check a token without using it. Available only when share-token imports are enabled for your organization. Contact support to enable it.

Initiate customer KYC POST

Generates a KYC flow link for a customer. The link is stable and can be reused to resume verification until the customer is approved. Organizations using Sumsub-hosted verification links instead receive a Sumsub-hosted link that expires after 7 days; call this endpoint again to get a fresh link for the same verification. For these organizations, a verified customer receives a link to their completed verification, and the endpoint returns `400` when that is unavailable or when the customer's identity matches an already verified identity. Some AUD-only customers receive a new link on every call; call this endpoint again whenever you send them a link.