# Create a partner

This API allows users to add new parties who can transact.

Endpoint: POST /v0/collections/partners
Version: 0.0.1
Security: Bearer

## Security:

  - `Bearer` (unknown)
    http bearer JWT

## Request fields (application/json):

  - `name` (string, required)
    Full name of the partner organization or individual
    Example: Nigerian Imports Ltd.

  - `email` (string, required)
    Email address for partner communications
    Example: nigerian@imports.com

  - `external_reference_id` (string)
    External reference id for partner
    Example: Ref-123

  - `data` (object)

  - `data.type` (string, required)
    Discriminator: indicates this is business metadata
    Enum: "BUSINESS"

  - `data.legal_entity` (string, required)
    Legal name of the business entity
    Example: Nigerian Imports Ltd.

  - `data.registration_number` (string, required)
    Business registration number
    Example: RC-123456-NGR

  - `data.registration_type` (string, required)
    Business registration/identification type
    Enum: "AIIN", "BANK", "BOID", "CBID", "CHID", "CINC", "COID", "CUST", "DUNS", "EMPL", "GS1G", "SREN", "SRET", "TXID", "USCC"

  - `data.country` (string, required)
    Country where the business is registered
    Example: NG

  - `data.city` (string)
    City where the business is located
    Example: Lagos Island

  - `data.postal_code` (string)
    Postal code of the business address
    Example: 10010

  - `data.address` (string, required)
    Primary address of the business
    Example: 15 Marina Street

  - `data.address_line_2` (string)
    Secondary address line
    Example: Suite 200

  - `data.type` (string, required)
    Discriminator: indicates this is individual metadata
    Enum: "INDIVIDUAL"

  - `data.first_name` (string, required)
    First name of the individual
    Example: John

  - `data.last_name` (string, required)
    Last name of the individual
    Example: Doe

  - `data.date_of_birth` (string, required)
    Date of birth of the individual
    Example: 1990-05-15

  - `data.identification_number` (string, required)
    Identification number of the individual

  - `data.identification_type` (string, required)
    Identification type for the individual identifier
    Enum: "AIIN", "ARNU", "CCPT", "DRLC", "NIDN", "POID", "SOS", "TXID"

  - `data.country` (string, required)
    Country of residence
    Example: United States

  - `data.city` (string)
    City of residence
    Example: New York

  - `data.postal_code` (string)
    Postal code of residence
    Example: 10001

  - `data.address` (string, required)
    Primary address of residence
    Example: 123 Main Street

## Response 201:

  - `201` (unknown)
    Partner created successfully.

## Response 201 fields (application/json):

  - `id` (string, required)
    Unique identifier for the partner
    Example: 0c5479ff-3772-4123-b2b7-e679e71eb570

  - `name` (string, required)
    Full name of the partner organization or individual
    Example: Nigerian Imports Ltd.

  - `email` (string, required)
    Email address for partner communications
    Example: nigerian@imports.com

  - `external_reference_id` (string)
    External reference id for partner
    Example: Ref-123

  - `data` (object)

  - `data.type` (string, required)
    Discriminator: indicates this is business metadata
    Enum: "BUSINESS"

  - `data.legal_entity` (string, required)
    Legal name of the business entity
    Example: Nigerian Imports Ltd.

  - `data.registration_number` (string, required)
    Business registration number
    Example: RC-123456-NGR

  - `data.registration_type` (string, required)
    Business registration/identification type
    Enum: "AIIN", "BANK", "BOID", "CBID", "CHID", "CINC", "COID", "CUST", "DUNS", "EMPL", "GS1G", "SREN", "SRET", "TXID", "USCC"

  - `data.country` (string, required)
    Country where the business is registered
    Example: NG

  - `data.city` (string)
    City where the business is located
    Example: Lagos Island

  - `data.postal_code` (string)
    Postal code of the business address
    Example: 10010

  - `data.address` (string, required)
    Primary address of the business
    Example: 15 Marina Street

  - `data.address_line_2` (string)
    Secondary address line
    Example: Suite 200

  - `data.type` (string, required)
    Discriminator: indicates this is individual metadata
    Enum: "INDIVIDUAL"

  - `data.first_name` (string, required)
    First name of the individual
    Example: John

  - `data.last_name` (string, required)
    Last name of the individual
    Example: Doe

  - `data.date_of_birth` (string, required)
    Date of birth of the individual
    Example: 1990-05-15

  - `data.identification_number` (string, required)
    Identification number of the individual

  - `data.identification_type` (string, required)
    Identification type for the individual identifier
    Enum: "AIIN", "ARNU", "CCPT", "DRLC", "NIDN", "POID", "SOS", "TXID"

  - `data.country` (string, required)
    Country of residence
    Example: United States

  - `data.city` (string)
    City of residence
    Example: New York

  - `data.postal_code` (string)
    Postal code of residence
    Example: 10001

  - `data.address` (string, required)
    Primary address of residence
    Example: 123 Main Street

  - `status` (string, required)
    Partner status for collection links or channels
    Enum: "PENDING", "ON_HOLD", "FAILED", "ACTIVATED", "DEACTIVATED"

  - `reason` (string)
    Reason for current status (if applicable)
    Example: null

  - `created_at` (string, required)
    Timestamp when the partner was created
    Example: 2025-09-18T22:54:00.542Z

  - `updated_at` (string, required)
    Timestamp when the partner was last updated
    Example: 2025-09-18T23:54:00.542Z

## Response 400:

  - `400` (unknown)
    Bad Request - Invalid input parameters

## Response 400 fields (application/json):

  - `code` (string, required)
    Error code identifying the type of error

  - `reason` (string, required)
    Human-readable error message

## Response 401:

  - `401` (unknown)
    Unauthorized - Invalid or missing authentication

## Response 401 fields (application/json):

  - `code` (string, required)
    Error code identifying the type of error

  - `reason` (string, required)
    Human-readable error message

## Response 500:

  - `500` (unknown)
    Internal server error

## Response 500 fields (application/json):

  - `code` (string, required)
    Error code identifying the type of error

  - `reason` (string, required)
    Human-readable error message