Skip to content

➕ Create a new client

Request

Create a new client with the provided details.

This endpoint allows you to create new PDP client IDs that can be used with other API endpoints. Each client is associated with an external reference for easy identification in your systems.

Note: This endpoint does not require the X-PDP-Client-ID header since it's used to create new client IDs.

Security
APIKeyHeader
Bodyapplication/jsonrequired
organization_namestring, [ 1 .. 255 ] characters(Organization Name)required

Name of the organization

contact_emailstring, <= 255 characters(Contact Email)required

Contact email for the organization

external_refstring, [ 1 .. 100 ] characters(External Ref)required

External reference identifier

curl -i -X POST \
  https://pdp.seqino.dev/api/clients \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "organization_name": "Acme Corporation",
    "contact_email": "contact@acme.com",
    "external_ref": "EXT-12345"
  }'

Responses

Client created successfully

Bodyapplication/json
client_idstring(Client Id)

Unique client identifier

organization_namestring(Organization Name)required

Name of the organization

contact_emailstring(Contact Email)required

Contact email for the organization

external_refstring(External Ref)required

External reference identifier

sponsor_idstring(Sponsor Id)required

PDP sponsor ID from the X-PDP-Sponsor-Id header

statusstring(ClientStatus)required

Current status of the client

Enum:"active""inactive""pending""suspended"
created_atstring, (date-time)(Created At)required

When the client was created

updated_atstring or null(Updated At)
Any of:

When the client was last updated

string (date-time)
Response
{ "client_id": "string", "organization_name": "string", "contact_email": "string", "external_ref": "string", "sponsor_id": "string", "status": "active", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }