Skip to main content
POST
Simulate onboarding requirements

Authorizations

X-API-Key
string
header
required

API Key

Headers

IDEMPOTENCY-KEY
string
required
X-API-Version
string

Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01, 2026-08-01, 2026-10-01, 2026-10-15.

Path Parameters

customer_id
string<uuid>
required

Body

application/json; charset=utf-8
inEdd
boolean

Enable or clear EDD simulation (individuals only). Omit to leave it unchanged.

isRejected
boolean

Enable or clear a retryable requirement rejection. Omit to leave it unchanged.

Response

Identification

The entity wrapping our KYC/KYB process and underlying providers

blocking_abilities
object
required

Rails (e.g. "ach", "sepa_thirdparty") provider onboarding ruled out for this applicant, keyed to a partner-safe reason. Empty until onboarding has run.

created_at
string<date-time>
required
id
string<uuid>
required
status
enum<string>
required

The Process status of the identification

The various state transitions an identification can go through.

Available options:
Pending,
Processed,
PendingReview,
Approved,
Declined,
Expired,
Archived
updated_at
string<date-time>
required
customer_id
string<uuid>

Absent on a referral partner's identification (partner-keyed record)

partner_id
string<uuid>

The owning partner for partner-keyed (referral) records

preflight_summary
IdentificationPreflightSummary · object
deprecated

Deprecated — always null. Removed in the next API version.

residence_country
string

ISO 3166-1 alpha-2 (2 letter) country code of the verified residence address; only set on the customer's most recent identification while it is approved

review_comment
string
step_status
BusinessIdentificationStepStatus · object
url
string
with_edd
boolean