For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
API StatusPartner Portal
HomeGuidesAPI ExplorerSDKsGitHubSupport
HomeGuidesAPI ExplorerSDKsGitHubSupport
  • API Concepts
    • Overview
    • Environments and URLs
    • Authentication
    • API versioning
    • Rate limiting
    • HTTP headers
    • Pagination, sorting, and filtering
  • General
  • Common
  • Accounts payable
  • Accounts receivable
  • E-invoicing
  • Payments
      • GETGet onboarding requirements
      • GETGet onboarding requirements
  • Accounting integration
  • Expense management
  • Utilities
LogoLogo
API StatusPartner Portal
PaymentsOnboarding requirements

Get onboarding requirements

Deprecated
GET
/entities/:entity_id/onboarding_requirements
GET
/v1/entities/:entity_id/onboarding_requirements
$curl https://api.sandbox.monite.com/v1/entities/entity_id/onboarding_requirements \
>     -H "x-monite-version: 2024-05-25" \
>     -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}

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

Was this page helpful?
Previous

Get onboarding requirements

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

entity_idstringRequired

Headers

x-monite-versionstringRequired

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