Get KYB status (GET)

cURL

curl --request GET \
  --url http://sandbox.mintlify.com/business/kyb/status \
  --header 'Authorization: Bearer <token>'

{
  "status": "not_started",
  "progress": 50,
  "last_updated": "2023-11-07T05:31:56Z",
  "next_steps": [
    "<string>"
  ]
}

GET

business

kyb

status

cURL

curl --request GET \
  --url http://sandbox.mintlify.com/business/kyb/status \
  --header 'Authorization: Bearer <token>'

{
  "status": "not_started",
  "progress": 50,
  "last_updated": "2023-11-07T05:31:56Z",
  "next_steps": [
    "<string>"
  ]
}

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

business_id

string

required

Business ID to check KYB status for

KYB status retrieved

status

enum<string>

required

Current KYB status

Available options:

not_started,

in_progress,

pending_review,

approved,

rejected

progress

integer

required

Completion percentage

Required range: 0 <= x <= 100

last_updated

string<date-time>

Last status update timestamp

next_steps

string[]

Next required actions

⌘I