Retrieve a counterparty

GET

/counterparties/{id}

Fetches a single counterparty by its unique identifier. The counterparty must belong to the authenticated entity — you cannot retrieve counterparties belonging to other entities.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

Counterparty found and returned successfully.

Bodyapplication/json

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location '/counterparties/01HZ9KPQR3VTXMN84JWYB65CD0' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "message": "Counterparty retrieved successfully",
    "status": "success",
    "data": {
        "id": "01HZ9KPQR3VTXMN84JWYB65CD0",
        "entity_id": "01HZ9ABCD1234EFGH5678IJKL90",
        "email": "jane.doe@example.com",
        "status": "active",
        "first_name": "Jane",
        "last_name": "Doe",
        "phonenumber": "+2348031234567",
        "client_reference": "cust-00412",
        "client_meta": {
            "tier": "premium",
            "segment": "retail"
        },
        "address": {
            "line1": "12 Broad Street",
            "line2": "Floor 3",
            "code": "100001",
            "code_type": "postal",
            "city": "Lagos Island",
            "state": "Lagos",
            "country": "NG"
        },
        "created": 1722870000000,
        "updated": 1722873600000
    }
}

Modified at 2026-08-12 16:05:45

Update a counterparty

Create a maker-checker approver group