Skip to main content
GET
/
kyb
Get KYB Application
curl --request GET \
  --url https://api.rolla.xyz/api/v1/external/kyb \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "message": "Application retrieved successfully",
  "data": {
    "application": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "draft",
      "current_step": 123,
      "is_complete": true,
      "business_info": {
        "legalName": "Acme Corp Ltd",
        "tradingName": "<string>",
        "businessType": "Limited Company",
        "incorporationDate": "2020-01-15",
        "incorporationCountry": "NG",
        "registrationNumber": "RC-1234567",
        "taxId": "12345678-0001",
        "website": "<string>",
        "description": "<string>",
        "monthlyVolume": "<string>",
        "annualRevenue": "<string>",
        "primaryFundingSource": "<string>"
      },
      "business_address": {
        "street": "123 Main Street",
        "city": "Lagos",
        "state": "Lagos",
        "postalCode": "100001",
        "country": "NG"
      },
      "contact_info": {
        "email": "contact@acmecorp.com",
        "phone": "+2341234567890"
      },
      "related_persons": [
        {
          "id": "<string>",
          "firstName": "John",
          "lastName": "Doe",
          "roles": [
            "Beneficial Owner"
          ],
          "email": "jsmith@example.com",
          "phone": "<string>",
          "dateOfBirth": "1990-01-15",
          "ownershipPercentage": 50,
          "currentAddress": {
            "street": "123 Main Street",
            "city": "Lagos",
            "state": "Lagos",
            "postalCode": "100001",
            "country": "NG"
          },
          "sourceOfWealthExplanation": "<string>",
          "bvn": "<string>",
          "nin": "<string>"
        }
      ],
      "banking_info": {
        "bankName": "<string>",
        "accountNumber": "<string>",
        "routingNumber": "<string>",
        "accountType": "checking",
        "currency": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  }
}
Retrieve the KYB (Know Your Business) application for your business, including business information, address, contact details, and verification status.

Example Request

curl -X GET "https://api.rolla.xyz/api/v1/external/kyb" \
  -H "X-API-Key: your_api_key_here"

Example Response

{
  "success": true,
  "message": "Application retrieved successfully",
  "data": {
    "application": {
      "id": "f6a7b8c9-d0e1-2345-fghi-678901234567",
      "status": "submitted",
      "current_step": 4,
      "is_complete": true,
      "business_info": {
        "legalName": "Acme Corp Ltd",
        "tradingName": "Acme",
        "businessType": "Limited Company",
        "incorporationDate": "2020-01-15",
        "incorporationCountry": "NG",
        "registrationNumber": "RC-1234567",
        "taxId": "12345678-0001"
      },
      "business_address": {
        "street": "123 Main Street",
        "city": "Lagos",
        "state": "Lagos",
        "postalCode": "100001",
        "country": "NG"
      },
      "contact_info": {
        "email": "contact@acmecorp.com",
        "phone": "+2341234567890"
      },
      "created_at": "2024-01-10T08:00:00.000Z",
      "updated_at": "2024-01-15T12:00:00.000Z"
    }
  }
}

Application Statuses

StatusDescription
draftApplication is incomplete and can be edited
submittedApplication has been submitted for review
approvedApplication has been approved
rejectedApplication has been rejected
changes_requestedChanges have been requested before approval

Authorizations

X-API-Key
string
header
required

Your Rolla API key

Response

Application retrieved successfully

success
boolean
Example:

true

message
string
Example:

"Application retrieved successfully"

data
object