Create party

POST

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

Create a new party (supplier/customer).

Authorizations

• HTTPBearer
• HTTPBearer

Parameters

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

Request Body ^required

PartyCreate

Create party schema.

object

legal_name

required

Legal Name

string

>= 1 characters <= 500 characters

trading_name

Any of:

string

string

<= 500 characters

null

null

party_type

PartyType

Party type enumeration.

string

default: customer

Allowed values: supplier customer both

tax_id

Any of:

string

string

<= 100 characters

null

null

registration_number

Any of:

string

string

<= 100 characters

null

null

email

Any of:

string

string format: email

null

null

phone

Any of:

string

string

<= 50 characters

null

null

website

Any of:

string

string

<= 500 characters

null

null

business_description

Any of:

string

string

null

null

notes

Any of:

string

string

null

null

is_peppol_participant

Is Peppol Participant

boolean

identifiers

Identifiers

Array<object>

default:

PartyIdentifierCreate

Create party identifier schema.

object

scheme_id

required

Scheme Id

ISO 6523 scheme code (e.g., 0088 for GLN)

string

<= 10 characters

identifier

required

Identifier

string

<= 200 characters

is_primary

Is Primary

boolean

addresses

Addresses

Array<object>

default:

AddressCreate

Create address schema.

object

address_type

Address Type

string

default: postal <= 20 characters

street_name

Any of:

string

string

<= 500 characters

null

null

additional_street_name

Any of:

string

string

<= 500 characters

null

null

building_number

Any of:

string

string

<= 50 characters

null

null

city_name

required

City Name

string

<= 100 characters

postal_zone

Any of:

string

string

<= 20 characters

null

null

state

Any of:

string

string

<= 100 characters

null

null

lga

Any of:

string

string

<= 200 characters

null

null

country_code

required

Country Code

ISO 3166-1 alpha-2

string

<= 2 characters

department

Any of:

string

string

<= 200 characters

null

null

po_box

Any of:

string

string

<= 50 characters

null

null

is_primary

Is Primary

boolean

bank_accounts

Bank Accounts

Array<object>

default:

BankAccountCreate

Create bank account schema.

object

bank_name

Any of:

string

string

<= 255 characters

null

null

bank_code

Any of:

string

string

<= 50 characters

null

null

branch_code

Any of:

string

string

<= 50 characters

null

null

branch_name

Any of:

string

string

<= 255 characters

null

null

account_name

Any of:

string

string

<= 255 characters

null

null

account_number

required

Account Number

string

<= 100 characters

iban

Any of:

string

string

<= 34 characters

null

null

swift_code

Any of:

string

string

<= 11 characters

null

null

currency_code

Currency Code

string

default: NGN <= 3 characters

is_primary

Is Primary

boolean

Examples

Create party request example

{
  "legal_name": "Optimum Business Solution Ltd",
  "trading_name": "OBS",
  "party_type": "customer",
  "tax_id": "TIN-12345678",
  "registration_number": "RC-900123",
  "email": "ap@obs.ng",
  "phone": "+2348012345678",
  "website": "https://obs.ng",
  "business_description": "ERP and accounting integration services",
  "notes": "Primary enterprise customer",
  "is_peppol_participant": true,
  "identifiers": [
    {
      "scheme_id": "0088",
      "identifier": "9501234567890",
      "is_primary": true
    }
  ],
  "addresses": [
    {
      "address_type": "postal",
      "street_name": "Adeola Odeku Street",
      "building_number": "12",
      "city_name": "Lagos",
      "postal_zone": "101241",
      "state": "Lagos",
      "country_code": "NG",
      "is_primary": true
    }
  ],
  "bank_accounts": [
    {
      "bank_name": "First Bank of Nigeria",
      "bank_code": "011",
      "account_name": "Optimum Business Solution Ltd",
      "account_number": "0123456789",
      "currency_code": "NGN",
      "is_primary": true
    }
  ]
}

Responses

201

Successful Response

Examples

Created party response

{
  "id": "8a1c7f6c-61a1-4d89-8d96-3f7e7747f0c0",
  "legal_name": "Optimum Business Solution Ltd",
  "party_type": "customer",
  "created_at": "2026-02-11T10:12:30Z",
  "updated_at": "2026-02-11T10:12:30Z"
}

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"
    }
  ]
}