Get onboarding requirements

Deprecated

GET

/entities/:entity_id/onboarding_requirements

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

Path parameters

entity_idstringRequired

Headers

Auth

AuthorizationstringRequired

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

x-monite-versionstringRequired

Response

Successful Response

requirementsobject

requirements_errorslist of objects

verification_errorslist of objects

verification_statusenum

Allowed values: enableddisabledpending

disabled_reasonenumOptional

Errors

GET

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

200Retrieved

1 {
2   "requirements": {
3     "currently_due": [
4       "currently_due"
5     ],
6     "eventually_due": [
7       "eventually_due"
8     ],
9     "pending_verification": [
10       "pending_verification"
11     ],
12     "current_deadline": "2024-01-15T09:30:00Z"
13   },
14   "requirements_errors": [
15     {
16       "code": "code",
17       "reason": "reason",
18       "requirement": "requirement"
19     }
20   ],
21   "verification_errors": [
22     {
23       "code": "code",
24       "details": "details"
25     }
26   ],
27   "verification_status": "enabled",
28   "disabled_reason": "requirements.past_due"
29 }

Get onboarding requirements

Up Next

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

1	{
2	"requirements": {
3	"currently_due": [
4	"currently_due"
5	],
6	"eventually_due": [
7	"eventually_due"
8	],
9	"pending_verification": [
10	"pending_verification"
11	],
12	"current_deadline": "2024-01-15T09:30:00Z"
13	},
14	"requirements_errors": [
15	{
16	"code": "code",
17	"reason": "reason",
18	"requirement": "requirement"
19	}
20	],
21	"verification_errors": [
22	{
23	"code": "code",
24	"details": "details"
25	}
26	],
27	"verification_status": "enabled",
28	"disabled_reason": "requirements.past_due"
29	}