API Reference

Onboard a customer

post
https://api.checker.finance/v1/payments/customers//onboard

Start onboarding for a customer. BUSINESS customers onboard with their KYB block; INDIVIDUAL customers onboard with their KYC block and are only supported by providers offering individual onboarding (attempting an INDIVIDUAL onboard at a business-only provider returns VALIDATION_ERROR). On success, returns status: PENDING, which advances asynchronously to ACTIVE, FAILED, SUSPENDED, or REJECTED. Repeated onboards are idempotent. If an attempt fails part-way (for example a document upload error), retrying continues the same application at the provider rather than creating a new one. See the response codes for error conditions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string
required

The payment provider to onboard the customer with

Headers
string
required

Idempotency key required on all write requests. Replaying the same key with the same body returns the original response.

string
required

Your API key

string
required

Request timestamp (ISO 8601 UTC), included in the signature payload

string
required

Unique request nonce (e.g. UUID)

string
required

HMAC-SHA256 hex digest of {METHOD}\n{path}\n{query}\n{X-Timestamp}\n{body}, signed with your API secret. Path excludes the query string; use an empty string for query/body when absent.

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?