Get party details

GET

/api/v1/tenants/{tenant_id}/workspaces/{workspace_id}/parties/{party_id}

Get detailed information about a party including addresses, bank accounts, and identifiers.

Authorizations

• HTTPBearer
• HTTPBearer

Parameters

Path Parameters

party_id

required

Party Id

string format: uuid

Header Parameters

X-Workspace-ID

Any of:

string

string

null

null

X-API-Key

Any of:

string

string

null

null

X-Tenant-ID

Any of:

string

string

null

null

Responses

200

Successful Response

Examples

Party profile response

{
  "id": "8a1c7f6c-61a1-4d89-8d96-3f7e7747f0c0",
  "legal_name": "Optimum Business Solution Ltd",
  "trading_name": "OBS",
  "party_type": "customer",
  "tax_id": "TIN-12345678",
  "email": "ap@obs.ng",
  "phone": "+2348012345678",
  "addresses": [
    {
      "city_name": "Lagos",
      "country_code": "NG",
      "street_name": "Adeola Odeku Street"
    }
  ],
  "bank_accounts": [
    {
      "bank_name": "First Bank of Nigeria",
      "account_number": "0123456789",
      "currency_code": "NGN"
    }
  ]
}

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Examples

422 response example

{
  "detail": [
    {
      "loc": [],
      "msg": "string",
      "type": "string"
    }
  ]
}