Skip to main content

Response Basics

# Standard Response Headers
Content-Type: application/json
x-request-id: SERVER_GENERATED_ID
x-api-version: 1.2

Success Response Example

An example of borrower response body.
{
    "items": [
        {
            "ID": 1001,
            "Country": "United States",
            "BusinessName": "Acme Corporation",
            "Phone": "+1 (555) 123-4567",
            "Email": "[email protected]",
            "Address": "123 Main Street, Suite 400, New York, NY 10001",
            "CreditScore": 0,
            "RegistrationNumber": "US-ACME-2020-001",
            "CreatedAt": "2025-08-12T10:19:27.447634Z",
            "UpdatedAt": "2025-08-12T10:19:27.447634Z"
        }
    ],
    "total": 11,
    "page": 1,
    "rowsPerPage": 1
}

Failure Response Example

An example of borrower response body.
{
  "code": "101",
  "message": "Missing required field: borrower_country",
}