Skip to main content
GET
List a user's onboardings

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<mongoId>
required

ID of the user.

Example:

"66562bc04fe8bf83c577c178"

Response

OK

productCode
string

The product in a country: product id, then country, lowercase.

Example:

"stablecoin-fx-pe"

productId
string
Example:

"stablecoin-fx"

country
string
Example:

"PE"

status
enum<string>

incomplete while anything is missing (or after compliance asks for more), submitted once sent for review, then approved or rejected.

Available options:
incomplete,
submitted,
approved,
rejected
Example:

"incomplete"

missing
string[]

Requirement keys still outstanding. Empty once the onboarding can be submitted.

Example:
requirements
object[]

Everything the onboarding asks for, required or not, and whether it has been received.

answers
object

Every answer received so far, by key. Text longer than 2,000 characters is cut short.

Example:
documents
object[]
terms
object
verification
object
startedAt
string<date-time>
submittedAt
string<date-time>
decidedAt
string<date-time>