Get Requirements

curl --request GET \
  --url https://api.rolla.xyz/api/v1/external/accounts/{accountId}/requirements \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/requirements"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.rolla.xyz/api/v1/external/accounts/{accountId}/requirements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/requirements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/requirements"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.rolla.xyz/api/v1/external/accounts/{accountId}/requirements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Requirements retrieved successfully",
  "data": {
    "entityType": "business",
    "status": "draft",
    "readyToSubmit": true,
    "missingFields": [
      "business_info.legalName"
    ],
    "missingDocuments": [
      "certificate_of_incorporation"
    ],
    "relatedPersons": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "verification": "verified"
      }
    ],
    "identityVerification": "verified"
  }
}

{
  "success": false,
  "message": "<string>"
}

{
  "success": false,
  "message": "<string>"
}

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>'

import requests

url = "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/requirements"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.rolla.xyz/api/v1/external/accounts/{accountId}/requirements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/requirements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/requirements"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.rolla.xyz/api/v1/external/accounts/{accountId}/requirements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Requirements retrieved successfully",
  "data": {
    "entityType": "business",
    "status": "draft",
    "readyToSubmit": true,
    "missingFields": [
      "business_info.legalName"
    ],
    "missingDocuments": [
      "certificate_of_incorporation"
    ],
    "relatedPersons": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "verification": "verified"
      }
    ],
    "identityVerification": "verified"
  }
}

{
  "success": false,
  "message": "<string>"
}

{
  "success": false,
  "message": "<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": [
      "related_persons.a3d4f21e-f499-488f-8508-43228dfea485.taxId",
      "related_persons.a3d4f21e-f499-488f-8508-43228dfea485.sourceOfWealthExplanation"
    ],
    "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",
        "missingFields": [
          "related_persons.a3d4f21e-f499-488f-8508-43228dfea485.taxId",
          "related_persons.a3d4f21e-f499-488f-8508-43228dfea485.sourceOfWealthExplanation"
        ],
        "missingDocuments": [
          "related_persons.a3d4f21e-f499-488f-8508-43228dfea485.proof_of_address",
          "related_persons.a3d4f21e-f499-488f-8508-43228dfea485.source_of_wealth_doc"
        ]
      }
    ]
  }
}

Individual account

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

Why an account is not ready

When readyToSubmit is false, submitBlocker names the reason — the same one Submit would return if you called it now. Check it instead of re-deriving the reason from the other fields.

{
  "submitBlocker": {
    "code": "APPLICATION_INCOMPLETE",
    "message": "Application is incomplete",
    "details": {
      "missingFields": ["individualInfo.nin"],
      "missingDocuments": ["proof_of_address"]
    }
  }
}

Missing data is reported first. Once the application is complete and identity verification is the only hold, the code becomes KYC_INCOMPLETE:

{
  "submitBlocker": {
    "code": "KYC_INCOMPLETE",
    "message": "Identity verification is not complete",
    "details": { "identityVerification": "pending" }
  }
}

For a business, details.unverified lists who is outstanding:

{
  "submitBlocker": {
    "code": "KYC_INCOMPLETE",
    "message": "Not every beneficial owner has completed KYC",
    "details": {
      "unverified": [
        { "personId": "a3d4f21e-f499-488f-8508-43228dfea485", "name": "Jane Doe" }
      ]
    }
  }
}

An account can have identityVerification: "verified" and still not be submittable — a passed identity check does not mean the application data is complete. submitBlocker is what tells the two apart.

Response Fields

Field	Type	Description
`readyToSubmit`	boolean	`true` only when everything is cleared: no missing fields, no missing documents, and identity verification complete — `identityVerification` for an individual, every entry in `relatedPersons` for a business
`missingFields`	string[]	Required application fields not yet provided, e.g. `business_info.legalName`. Entries prefixed `related_persons.<id>.` belong to that person
`missingDocuments`	string[]	Required document types not yet uploaded, including each related person’s own documents
`relatedPersons`	object[]	Business only: each related person with their KYC `verification` state (`verified`, `pending`, `unknown`) and their own `missingFields` / `missingDocuments`
`identityVerification`	string	Individual only: identity verification state (`verified`, `pending`, `unknown`)
`submitBlocker`	object \| null	`null` when the account is ready. Otherwise `code` (`APPLICATION_INCOMPLETE` or `KYC_INCOMPLETE`), a human-readable `message`, and `details` carrying the specifics

A business must declare at least one beneficial owner or director. Until one is added, missingFields contains related_persons.

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

Show child attributes

Overview

Banks

Account Lookup

Transactions

Wallet

Beneficiaries

Teams

Account Onboarding

Webhooks

Get Requirements

Example Request

Example Response

Business account

Individual account

Why an account is not ready

Response Fields

Authorizations

Path Parameters

Response

​Example Request

​Example Response

​Business account

​Individual account

​Why an account is not ready

​Response Fields

Authorizations

Path Parameters

Response

Example Request

Example Response

Business account

Individual account

Why an account is not ready

Response Fields