Skip to main content
GET
/
accounts
/
{accountId}
/
bank-accounts
/
requirements
Get Issuance Requirements
curl --request GET \
  --url https://api.rolla.xyz/api/v1/external/accounts/{accountId}/bank-accounts/requirements \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "message": "Bank account requirements retrieved successfully",
  "data": {
    "currency": "<string>",
    "provider": "<string>",
    "applicationApproved": true,
    "requiredFields": [
      "<string>"
    ],
    "missingFields": [
      "<string>"
    ],
    "onboardingState": "<string>",
    "prefilled": {},
    "availableDocuments": {}
  }
}
Shows everything needed to issue a bank account for the given currency: which provider will be used, the details prefilled from the account’s application, and anything still missing. Whatever is missing can be supplied via accountData when calling Issue Bank Account.

​
Example Request

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

​
Example Response

​
NGN

{
  "success": true,
  "message": "Bank account requirements retrieved successfully",
  "data": {
    "currency": "NGN",
    "provider": "gtbank",
    "applicationApproved": true,
    "requiredFields": ["businessName", "businessIdentifier", "mobileNum", "bvn"],
    "missingFields": ["bvn"],
    "prefilled": {
      "businessName": "Beta Logistics LLC",
      "businessIdentifier": "LLC-123987",
      "mobileNum": "+13025550124",
      "bvn": ""
    }
  }
}

​
USD

{
  "success": true,
  "message": "Bank account requirements retrieved successfully",
  "data": {
    "currency": "USD",
    "provider": "ssb_usd",
    "applicationApproved": true,
    "onboardingState": null,
    "prefilled": {
      "onboardingDetails": {
        "businessInfo": { "name": "Beta Logistics LLC", "taxId": "98-7654321" },
        "businessAddress": { "line1": "77 Commerce Ave", "city": "Wilmington", "state": "DE", "postalCode": "19801", "country": "US" }
      },
      "representatives": [
        { "firstName": "Jane", "lastName": "Doe", "relatedPersonId": "a3d4f21e-f499-488f-8508-43228dfea485", "ownershipPercentage": 75, "isSigner": true }
      ],
      "kybDocs": [
        { "id": "0c95b2a1-7a93-4a3a-9a52-2a1f0b9b3c11", "type": "certificate_of_incorporation", "source": "rolla" }
      ]
    },
    "availableDocuments": {
      "business": [],
      "representatives": []
    }
  }
}

​
Response Fields

FieldDescription
providerProvider that will issue the account, chosen by currency and account type
applicationApprovedBank accounts can only be issued once the application is approved
requiredFields / missingFieldsNGN: fields the provider requires and which are still empty
onboardingStateUSD: provider onboarding state, null until first submission
prefilledThe payload that will be sent, built from the account’s application
availableDocumentsUSD: documents that will be attached, from the application and identity verification

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

Query Parameters

​
currency
enum<string>
required
Available options:
NGN,
USD

Response

Requirements retrieved

​
success
boolean
Example:

true

​
message
string
Example:

"Bank account requirements retrieved successfully"

​
data
object