Get onboarding requirements | Monite Documentation

curl https://api.sandbox.monite.com/v1/entities/entity_id/onboarding_requirements \
     -H "x-monite-version: 2024-05-25" \
     -H "Authorization: Bearer <token>"

{
  "requirements": {
    "currently_due": [
      "currently_due"
    ],
    "eventually_due": [
      "eventually_due"
    ],
    "pending_verification": [
      "pending_verification"
    ],
    "current_deadline": "2024-01-15T09:30:00Z"
  },
  "requirements_errors": [
    {
      "code": "code",
      "reason": "reason",
      "requirement": "requirement"
    }
  ],
  "verification_errors": [
    {
      "code": "code",
      "details": "details"
    }
  ],
  "verification_status": "enabled",
  "disabled_reason": "requirements.past_due"
}

Deprecated. Use GET /onboarding_requirements instead. Check the information required to complete the onboarding process.

Authentication

AuthorizationBearer

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

Path parameters

entity_idstringRequired

Response

Successful Response

requirementsobject

requirements_errorslist of objects

verification_errorslist of objects

verification_statusenum

Allowed values:

disabled_reasonenum

Errors

401

Get Entities ID Onboarding Requirements Request Unauthorized Error

422

Get Entities ID Onboarding Requirements Request Unprocessable Entity Error

429

Get Entities ID Onboarding Requirements Request Too Many Requests Error

Authentication

Path parameters

Headers

Response

Errors