Person Statuses
Understand the statuses for persons.
In the Deliver API, a person can have one of the following statuses, indicated by the status field.
A person was created to represent an individual or a person’s record was updated in a way that requires identity re-verification.
A person was created to represent an individual or a person’s record was updated in a way that requires identity re-verification.
A person passed identity verification. The person can send or receive funds with all transfer use cases.
A person did not pass identity verification. The person cannot send or receive funds.
A person matched a sanctions list during watchlist screening. The person cannot send or receive funds.
A person has been soft-deleted in Orum’s platform (this action can only be completed by the Orum team). The person cannot send or receive funds.
Regardless of whether you are using Orum’s customer identification provider (Orum-KYC) or your own customer identification provider (BYO-KYC), all persons you create will always move from a Created to a Verified status. The POST API response will return the person with a status
of created
.
Diagram
The below example shows how a person can move through the above statuses. A person can move from “verified” to “restricted” if they match a sanctions list anytime after their initial customer identification. To learn more about why a person is in the “rejected” or “restricted” state, refer to the status_reason
field in the API response.
If a person fails customer identification and is set to the rejected status, Orum will automatically kick off a manual review and attempt to retry the customer identification workflow to resolve the issue.
Was this page helpful?