Skip to main content
Depending on your integration type you might not need to create Identities for your end users. Identities must pass a set of verifications and checks before they’re able to transact on the Platform. Learn more about getting started with Identity and managing their onboarding lifecycle in the Identity Developer Guide.

​
Requirements in Identity responses

Identity responses include outstanding obligations in status_details.requirements. Each requirement includes its type, status, awaiting_action_from, and zero or more errors with a machine-readable code and a human-readable description. A requirement’s status describes a validation or remediation result. It is not the Identity’s approval decision: a TAX_DOCUMENTATION requirement can remain FAILED while the Identity is APPROVED. Use the Identity’s top-level status and status_details.active_controls to determine access restrictions. For required resubmission and other tax-documentation actions, see Failed tax requirements and approval. Use the requirement’s type to interpret its associated errors[].code. The current mapping is below; an error code applies only in the context of its associated requirement type. Additional error codes may be added. Build integrations to handle unknown codes gracefully.