Skip to main content
GET
/
onboarding_requirements
Get onboarding requirements
curl --request GET \
  --url https://api.sandbox.monite.com/v1/onboarding_requirements \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "data": [
    {
      "payment_method": "<string>",
      "requirements": {
        "currently_due": [
          "<string>"
        ],
        "eventually_due": [
          "<string>"
        ],
        "past_due": [
          "<string>"
        ],
        "pending_verification": [
          "<string>"
        ],
        "current_deadline": "2023-11-07T05:31:56Z"
      },
      "requirements_errors": [
        {
          "code": "<string>",
          "reason": "<string>",
          "requirement": "<string>"
        }
      ],
      "verification_errors": [
        {
          "code": "<string>",
          "details": "<string>"
        }
      ],
      "verification_status": "enabled",
      "disabled_reason": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Headers

x-monite-version
string<date>
required
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Response

Successful Response

data
object[]
required