Skip to main content
GET
/
accounts
/
{accountId}
/
requirements
Get Requirements
curl --request GET \
  --url https://api.rolla.xyz/api/v1/external/accounts/{accountId}/requirements \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "message": "Requirements retrieved successfully",
  "data": {
    "readyToSubmit": true,
    "missingFields": [
      "business_info.legalName"
    ],
    "missingDocuments": [
      "certificate_of_incorporation"
    ],
    "relatedPersons": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ]
  }
}
Returns a live checklist of everything still required before the account’s application can be submitted: missing fields, missing documents and outstanding identity verifications. Use it to drive your own onboarding UI or to verify readiness before calling submit.

​
Example Request

curl -X GET "https://api.rolla.xyz/api/v1/external/accounts/eec3cbed-79d8-4370-87a0-b6be9e287337/requirements" \
  -H "X-API-Key: your_api_key_here"

​
Example Response

​
Business account

{
  "success": true,
  "message": "Requirements retrieved successfully",
  "data": {
    "entityType": "business",
    "status": "draft",
    "readyToSubmit": false,
    "missingFields": [],
    "missingDocuments": [
      "certificate_of_incorporation",
      "articles_of_association",
      "proof_of_address",
      "director_register",
      "shareholder_register",
      "bank_statement"
    ],
    "relatedPersons": [
      {
        "id": "a3d4f21e-f499-488f-8508-43228dfea485",
        "name": "Jane Doe",
        "verification": "pending"
      }
    ]
  }
}

​
Individual account

{
  "success": true,
  "message": "Requirements retrieved successfully",
  "data": {
    "entityType": "individual",
    "status": "draft",
    "readyToSubmit": true,
    "missingFields": [],
    "missingDocuments": [],
    "identityVerification": "verified"
  }
}

​
Response Fields

FieldTypeDescription
readyToSubmitbooleantrue when all required fields and documents are present
missingFieldsstring[]Required application fields not yet provided, e.g. business_info.legalName
missingDocumentsstring[]Required document types not yet uploaded
relatedPersonsobject[]Business only: each related person with their KYC verification state (verified, pending, unknown)
identityVerificationstringIndividual only: identity verification state (verified, pending, unknown)

Authorizations

​
X-API-Key
string
header
required

Your Rolla API key

Path Parameters

​
accountId
string<uuid>
required

Identifier of an account owned by the same user as your API key's business

Response

Requirements retrieved successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Requirements retrieved successfully"

​
data
object