📋 Get all clients

👥 Clients

Operations

📋 Get all clients

Request

Get all clients with their details.

Optionally filter by external_ref to find a specific client.

Security

APIKeyHeader

Query

external_refExternal Ref (string) or External Ref (null)(External Ref)

Any of:

string(External Ref)

curl -i -X GET \
  'https://pdp.seqino.dev/api/clients?external_ref=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

List of all clients, or client matching external_ref if provided

Bodyapplication/json

Any of:

Array [

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_atUpdated At (string) or Updated At (null)(Updated At)

When the client was last updated

Any of:

When the client was last updated

string(date-time)(Updated At)

]

Response

application/json

[]

➕ 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(Organization Name)[ 1 .. 255 ] charactersrequired

Name of the organization

Example: "Acme Corporation"

contact_emailstring(Contact Email)<= 255 charactersrequired

Contact email for the organization

Example: "contact@acme.com"

external_refstring(External Ref)[ 1 .. 100 ] charactersrequired

External reference identifier

Example: "EXT-12345"

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_atUpdated At (string) or Updated At (null)(Updated At)

When the client was last updated

Any of:

When the client was last updated

string(date-time)(Updated At)

Response

application/json

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

📄 Get client details

Request

Get detailed information about a specific client.

Security

APIKeyHeader

Path

client_idstring(Client Id)required

curl -i -X GET \
  'https://pdp.seqino.dev/api/clients/{client_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Client details

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_atUpdated At (string) or Updated At (null)(Updated At)

When the client was last updated

Any of:

When the client was last updated

string(date-time)(Updated At)

Response

application/json

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

🗑️ Delete a client

Request

Delete a client by ID.

Important: A client can only be deleted if they have no associated mandates. Delete all mandates for this client first before attempting to delete the client.

Security

APIKeyHeader

Path

client_idstring(Client Id)required

curl -i -X DELETE \
  'https://pdp.seqino.dev/api/clients/{client_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Client deleted successfully

Response

No content

🔗 Generate onboarding link for a client

Request

Generate an onboarding link for a specific client.

The onboarding experience can be customized with:

include_kyc: Add a Know Your Customer verification step
include_signature: Require electronic signature of the PDP mandate

The generated link is time-limited and client-specific.

Security

APIKeyHeader

Bodyapplication/jsonrequired

include_kycboolean(Include Kyc)

Include KYC (Know Your Customer) step in the onboarding experience

Default false

include_signatureboolean(Include Signature)

Require electronic signature of the PDP mandate during onboarding

Default false

callback_urlCallback Url (string) or Callback Url (null)(Callback Url)

URL to redirect to after onboarding completion

Example: "https://your-app.com/onboarding-complete"

Any of:

URL to redirect to after onboarding completion

string(Callback Url)

curl -i -X POST \
  https://pdp.seqino.dev/api/clients/onboarding-link \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "include_kyc": false,
    "include_signature": false,
    "callback_url": "https://your-app.com/onboarding-complete"
  }'

Responses

Onboarding link generated successfully

Bodyapplication/json

onboarding_urlstring(uri)(Onboarding Url)required

Generated onboarding URL

link_idstring(Link Id)required

Unique identifier for this onboarding link

expires_atstring(date-time)(Expires At)required

When this onboarding link expires

includes_kycboolean(Includes Kyc)required

Whether KYC step is included

includes_signatureboolean(Includes Signature)required

Whether electronic signature is required

callback_urlCallback Url (string) or Callback Url (null)(Callback Url)

Callback URL for redirection after completion

Any of:

Callback URL for redirection after completion

string(Callback Url)

Response

application/json

{
  "onboarding_url": "http://example.com",
  "link_id": "string",
  "expires_at": "2019-08-24T14:15:22Z",
  "includes_kyc": true,
  "includes_signature": true,
  "callback_url": "string"
}

📊 Get onboarding link status

Request

Get the status of an onboarding link for a client.

Returns the current progress including KYC and signature completion status.

Security

APIKeyHeader

Query

link_idLink Id (string) or Link Id (null)(Link Id)

Any of:

string(Link Id)

curl -i -X GET \
  'https://pdp.seqino.dev/api/clients/onboarding-link/status?link_id=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

link_idstring(Link Id)required

company_idstring(Company Id)required

statusstring(OnboardingLinkStatus)required

Enum"not_opened""opened""kyc_in_progress""kyc_completed""completed""expired"

created_atstring(date-time)(Created At)required

last_updatedstring(date-time)(Last Updated)required

expires_atExpires At (string) or Expires At (null)(Expires At)

Any of:

string(date-time)(Expires At)

completion_percentageinteger(Completion Percentage)[ 0 .. 100 ]required

Completion percentage (0-100)

includes_kycboolean(Includes Kyc)required

Whether KYC step is included in this onboarding

includes_signatureboolean(Includes Signature)required

Whether electronic signature is required

kyc_completedKyc Completed (boolean) or Kyc Completed (null)(Kyc Completed)

Whether KYC has been completed (if applicable)

Any of:

Whether KYC has been completed (if applicable)

boolean(Kyc Completed)

signature_completedSignature Completed (boolean) or Signature Completed (null)(Signature Completed)

Whether signature has been completed (if applicable)

Any of:

Whether signature has been completed (if applicable)

boolean(Signature Completed)

Response

application/json

{
  "link_id": "string",
  "company_id": "string",
  "status": "not_opened",
  "created_at": "2019-08-24T14:15:22Z",
  "last_updated": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "completion_percentage": 100,
  "includes_kyc": true,
  "includes_signature": true,
  "kyc_completed": true,
  "signature_completed": true
}

📋 Mandates

Operations

📝 Drafts

Operations

📘 Directory

Operations

🧾 Invoicing

Operations

🔄 Lifecycle

Operations

📊 Reporting

Operations

📊 Usage

Operations

⚙️ Settings

Operations

🔔 Webhooks

Operations

Health Check

Request

Health check endpoint.

curl -i -X GET \
  https://pdp.seqino.dev/health

Responses

Successful Response

Bodyapplication/json

any

Response

application/json

null

Seqino PDP API (1.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

👥 Clients

📋 Get all clients

Request

Responses

Was this helpful?

➕ Create a new client

Request

Responses

Was this helpful?

📄 Get client details

Request

Responses

Was this helpful?

🗑️ Delete a client

Request

Responses

Was this helpful?

🔗 Generate onboarding link for a client

Request

Responses

Was this helpful?

📊 Get onboarding link status

Request

Responses

Was this helpful?

📋 Mandates

📝 Drafts

📘 Directory

🧾 Invoicing

🔄 Lifecycle

📊 Reporting

📊 Usage

⚙️ Settings

🔔 Webhooks

Health Check

Request

Responses

Was this helpful?

Seqino PDP API (1.0.0)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

👥 Clients

📋 Get all clients

RequestExpand all

Responses

Was this helpful?

➕ Create a new client

Request

Responses

Was this helpful?

📄 Get client details

Request

Responses

Was this helpful?

🗑️ Delete a client

Request

Responses

Was this helpful?

🔗 Generate onboarding link for a client

RequestExpand all

Responses

Was this helpful?

📊 Get onboarding link status

RequestExpand all

Responses

Was this helpful?

📋 Mandates

📝 Drafts

📘 Directory

🧾 Invoicing

🔄 Lifecycle

📊 Reporting

📊 Usage

⚙️ Settings

🔔 Webhooks

Health Check

Request

Responses

Was this helpful?

Seqino PDP API (1.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Request

Request

Request