👥 Clients

Operations

📋 Get all clients

Request

Get all clients with their details.

curl -i -X GET \
  https://pdp-api-v250704-iron.seqino.dev/api/clients/

Responses

List of all clients

Bodyapplication/jsonArray [

client_idstring(Client Id)required

Unique client identifier

Example: "client_abc123"

organization_namestring(Organization Name)required

Name of the organization

Example: "Acme Corporation"

contact_emailstring(Contact Email)required

Contact email for the organization

Example: "contact@acme.com"

external_refstring(External Ref)required

External reference identifier

Example: "EXT-12345"

statusstring(ClientStatus)required

Status of the client.

Enum"active""inactive""pending""suspended"

Example: "active"

created_atstring(date-time)(Created At)required

When the client was created

Example: "2024-01-15T10:30:00Z"

updated_atUpdated At (string) or Updated At (null)(Updated At)

When the client was last updated

Example: "2024-01-15T14:20:00Z"

Any of:

When the client was last updated

string(date-time)(Updated At)

When the client was last updated

]

Response

application/json

[
  {
    "client_id": "client_abc123",
    "organization_name": "Acme Corporation",
    "contact_email": "contact@acme.com",
    "external_ref": "EXT-12345",
    "status": "active",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T14:20:00Z"
  }
]

➕ Create a new client

Request

Create a new client with the provided details.

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-api-v250704-iron.seqino.dev/api/clients/ \
  -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

clientobject(Client)required

Client model with all information.

client.client_idstring(Client Id)required

Unique client identifier

Example: "client_abc123"

client.organization_namestring(Organization Name)required

Name of the organization

Example: "Acme Corporation"

client.contact_emailstring(Contact Email)required

Contact email for the organization

Example: "contact@acme.com"

client.external_refstring(External Ref)required

External reference identifier

Example: "EXT-12345"

client.statusstring(ClientStatus)required

Status of the client.

Enum"active""inactive""pending""suspended"

Example: "active"

client.created_atstring(date-time)(Created At)required

When the client was created

Example: "2024-01-15T10:30:00Z"

client.updated_atUpdated At (string) or Updated At (null)(Updated At)

When the client was last updated

Example: "2024-01-15T14:20:00Z"

Any of:

When the client was last updated

string(date-time)(Updated At)

When the client was last updated

messagestring(Message)required

Response message

Example: "Client created successfully"

Response

application/json

{
  "client": {
    "client_id": "client_abc123",
    "organization_name": "Acme Corporation",
    "contact_email": "contact@acme.com",
    "external_ref": "EXT-12345",
    "status": "active",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T14:20:00Z"
  },
  "message": "Client created successfully"
}

🔗 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.

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)

URL to redirect to after onboarding completion

curl -i -X POST \
  https://pdp-api-v250704-iron.seqino.dev/api/clients/onboarding-link \
  -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)

Callback URL for redirection after completion

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.

Query

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

Any of:

string(Link Id)

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

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)

Whether KYC has been completed (if applicable)

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)

Whether signature has been completed (if applicable)

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
}

➕ Create new PDP client

Request

Create a new PDP client and associate it with an external reference.

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.

Bodyapplication/jsonrequired

external_referencestring(External Reference)required

External reference to associate with the PDP client

Example: "CUST-12345"

client_namestring(Client Name)required

Human-readable name for the client

Example: "ACME Corporation"

descriptionDescription (string) or Description (null)(Description)

Optional description of the client

Example: "Main client for ACME Corp operations"

Any of:

Optional description of the client

string(Description)

Optional description of the client

curl -i -X POST \
  https://pdp-api-v250704-iron.seqino.dev/api/clients/pdp-clients \
  -H 'Content-Type: application/json' \
  -d '{
    "external_reference": "CUST-12345",
    "client_name": "ACME Corporation",
    "description": "Main client for ACME Corp operations"
  }'

Responses

PDP client created successfully

Bodyapplication/json

pdp_client_idstring(Pdp Client Id)required

Generated PDP client ID

Example: "pdp_abc123def456"

external_referencestring(External Reference)required

Associated external reference

Example: "CUST-12345"

client_namestring(Client Name)required

Client name

Example: "ACME Corporation"

statusstring(Status)required

Client status

Example: "active"

created_atstring(date-time)(Created At)required

Creation timestamp

messagestring(Message)required

Success message

Response

application/json

{
  "pdp_client_id": "pdp_abc123def456",
  "external_reference": "CUST-12345",
  "client_name": "ACME Corporation",
  "status": "active",
  "created_at": "2019-08-24T14:15:22Z",
  "message": "string"
}

📋 Mandates

Operations

📝 Drafts

Operations

📘 Directory

Operations

🧾 Invoicing

Operations

🔄 Lifecycle

Operations

📊 Reporting

Operations

📊 Usage

Operations

⚙️ Settings

Operations

Health Check

Request

Health check endpoint.

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

Responses

Successful Response

Bodyapplication/json

any

Response

application/json

null

Seqino PDP API (1.0.0)

👥 Clients

📋 Get all clients

Request

Responses

Was this helpful?

➕ Create a new 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?

➕ Create new PDP client

Request

Responses

Was this helpful?

📋 Mandates

📝 Drafts

📘 Directory

🧾 Invoicing

🔄 Lifecycle

📊 Reporting

📊 Usage

⚙️ Settings

Health Check

Request

Responses

Was this helpful?

Seqino PDP API (1.0.0)

👥 Clients

📋 Get all clients

Request

Responses

Was this helpful?

➕ Create a new 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?

➕ Create new PDP client

RequestExpand all

Responses

Was this helpful?

📋 Mandates

📝 Drafts

📘 Directory

🧾 Invoicing

🔄 Lifecycle

📊 Reporting

📊 Usage

⚙️ Settings

Health Check

Request

Responses

Was this helpful?

Request

Request

Request