Get onboarding requirements

GET

/onboarding_requirements

Get onboarding requirements for the entity

Headers

Auth

AuthorizationstringRequired

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

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Response

Successful Response

datalist of objects

Errors

GET

1 curl https://api.sandbox.monite.com/v1/onboarding_requirements \
2      -H "x-monite-version: 2024-05-25" \
3      -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4      -H "Authorization: Bearer <token>"

200Retrieved

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

Get payment intents

Up Next

1	curl https://api.sandbox.monite.com/v1/onboarding_requirements \
2	-H "x-monite-version: 2024-05-25" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>"

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