👥 Clients

Opérations

📋 Get all clients

Requête

Get all clients with their details.

Optionally filter by external_ref to find a specific client.

Sécurité

APIKeyHeader

Requête

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'

Réponses

List of all clients, or client matching external_ref if provided

Corpsapplication/json

Any of:

Array [

client_idstring(Client Id)

Unique client identifier

organization_namestring(Organization Name)obligatoire

Name of the organization

contact_emailstring(Contact Email)obligatoire

Contact email for the organization

external_refstring(External Ref)obligatoire

External reference identifier

sponsor_idstring(Sponsor Id)obligatoire

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

statusstring(ClientStatus)obligatoire

Current status of the client

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

created_atstring(date-time)(Created At)obligatoire

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)

]

Réponse

application/json

[]

➕ Create a new client

Requête

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.

Sécurité

APIKeyHeader

Corpsapplication/jsonobligatoire

organization_namestring(Organization Name)[ 1 .. 255 ] charactersobligatoire

Name of the organization

Exemple: "Acme Corporation"

contact_emailstring(Contact Email)<= 255 charactersobligatoire

Contact email for the organization

Exemple: "contact@acme.com"

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

External reference identifier

Exemple: "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"
  }'

Réponses

Client created successfully

Corpsapplication/json

client_idstring(Client Id)

Unique client identifier

organization_namestring(Organization Name)obligatoire

Name of the organization

contact_emailstring(Contact Email)obligatoire

Contact email for the organization

external_refstring(External Ref)obligatoire

External reference identifier

sponsor_idstring(Sponsor Id)obligatoire

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

statusstring(ClientStatus)obligatoire

Current status of the client

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

created_atstring(date-time)(Created At)obligatoire

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)

Réponse

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

Requête

Get detailed information about a specific client.

Sécurité

APIKeyHeader

Chemin

client_idstring(Client Id)obligatoire

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

Réponses

Client details

Corpsapplication/json

client_idstring(Client Id)

Unique client identifier

organization_namestring(Organization Name)obligatoire

Name of the organization

contact_emailstring(Contact Email)obligatoire

Contact email for the organization

external_refstring(External Ref)obligatoire

External reference identifier

sponsor_idstring(Sponsor Id)obligatoire

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

statusstring(ClientStatus)obligatoire

Current status of the client

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

created_atstring(date-time)(Created At)obligatoire

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)

Réponse

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

✏️ Update client details

Requête

Update client details.

This endpoint allows you to update an existing client's information. Only the fields provided in the request will be updated; fields not included will remain unchanged.

Note: When updating external_ref, ensure it's unique for this sponsor.

Sécurité

APIKeyHeader

Chemin

client_idstring(Client Id)obligatoire

Corpsapplication/jsonobligatoire

organization_nameOrganization Name (string) or Organization Name (null)(Organization Name)

Name of the organization

Exemple: "Acme Corporation"

Any of:

Name of the organization

[ 1 .. 255 ] characters

string(Organization Name)[ 1 .. 255 ] characters

contact_emailContact Email (string) or Contact Email (null)(Contact Email)

Contact email for the organization

Exemple: "contact@acme.com"

Any of:

Contact email for the organization

<= 255 characters

string(Contact Email)<= 255 characters

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

External reference identifier

Exemple: "EXT-12345"

Any of:

External reference identifier

[ 1 .. 100 ] characters

string(External Ref)[ 1 .. 100 ] characters

statusClientStatus (string) or null

Current status of the client

Exemple: "active"

Any of:

Status of the client.

string(ClientStatus)

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

curl -i -X PUT \
  'https://pdp.seqino.dev/api/clients/{client_id}' \
  -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",
    "status": "active"
  }'

Réponses

Client updated successfully

Corpsapplication/json

client_idstring(Client Id)

Unique client identifier

organization_namestring(Organization Name)obligatoire

Name of the organization

contact_emailstring(Contact Email)obligatoire

Contact email for the organization

external_refstring(External Ref)obligatoire

External reference identifier

sponsor_idstring(Sponsor Id)obligatoire

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

statusstring(ClientStatus)obligatoire

Current status of the client

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

created_atstring(date-time)(Created At)obligatoire

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)

Réponse

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

Requête

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.

Sécurité

APIKeyHeader

Chemin

client_idstring(Client Id)obligatoire

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

Réponses

Client deleted successfully

Réponse

Aucun contenu

🔗 Generate onboarding link for a client

Requête

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.

Sécurité

APIKeyHeader

Corpsapplication/jsonobligatoire

include_kycboolean(Include Kyc)

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

Par défaut false

include_signatureboolean(Include Signature)

Require electronic signature of the PDP mandate during onboarding

Par défaut false

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

URL to redirect to after onboarding completion

Exemple: "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"
  }'

Réponses

Onboarding link generated successfully

Corpsapplication/json

onboarding_urlstring(uri)(Onboarding Url)obligatoire

Generated onboarding URL

link_idstring(Link Id)obligatoire

Unique identifier for this onboarding link

expires_atstring(date-time)(Expires At)obligatoire

When this onboarding link expires

includes_kycboolean(Includes Kyc)obligatoire

Whether KYC step is included

includes_signatureboolean(Includes Signature)obligatoire

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)

Réponse

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

Requête

Get the status of an onboarding link for a client.

Returns the current progress including KYC and signature completion status.

Sécurité

APIKeyHeader

Requête

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'

Réponses

Successful Response

Corpsapplication/json

link_idstring(Link Id)obligatoire

company_idstring(Company Id)obligatoire

statusstring(OnboardingLinkStatus)obligatoire

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

created_atstring(date-time)(Created At)obligatoire

last_updatedstring(date-time)(Last Updated)obligatoire

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

Any of:

string(date-time)(Expires At)

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

Completion percentage (0-100)

includes_kycboolean(Includes Kyc)obligatoire

Whether KYC step is included in this onboarding

includes_signatureboolean(Includes Signature)obligatoire

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)

Réponse

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

Opérations

📝 Drafts

Opérations

📘 Directory

Opérations

🧾 Invoicing

Opérations

🔄 Lifecycle

Opérations

📊 Reporting

Opérations

📊 Usage

Opérations

⚙️ Settings

Opérations

🔔 Webhooks

OpérationsWebhooks

Health Check

Requête

Health check endpoint.

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

Réponses

Successful Response

Corpsapplication/json

any

Réponse

application/json

null

Seqino PDP API (1.0.0)CopierCopier pour LLMCopier la page en Markdown pour les LLMVoir en MarkdownOuvrir cette page en MarkdownOuvrir dans ChatGPTObtenir des informations de ChatGPTOuvrir dans ClaudeObtenir des informations de Claude

👥 Clients

📋 Get all clients

RequêteTout développer

Réponses

Cela vous a-t-il été utile ?

➕ Create a new client

Requête

Réponses

Cela vous a-t-il été utile ?

📄 Get client details

Requête

Réponses

Cela vous a-t-il été utile ?

✏️ Update client details

RequêteTout développer

Réponses

Cela vous a-t-il été utile ?

🗑️ Delete a client

Requête

Réponses

Cela vous a-t-il été utile ?

🔗 Generate onboarding link for a client

RequêteTout développer

Réponses

Cela vous a-t-il été utile ?

📊 Get onboarding link status

RequêteTout développer

Réponses

Cela vous a-t-il été utile ?

📋 Mandates

📝 Drafts

📘 Directory

🧾 Invoicing

🔄 Lifecycle

📊 Reporting

📊 Usage

⚙️ Settings

🔔 Webhooks

Health Check

Requête

Réponses

Cela vous a-t-il été utile ?

Seqino PDP API (1.0.0)
Copier pour LLM
Copier la page en Markdown pour les LLM
Voir en Markdown
Ouvrir cette page en Markdown
Ouvrir dans ChatGPT
Obtenir des informations de ChatGPT
Ouvrir dans Claude
Obtenir des informations de Claude

Requête

Requête

Requête

Requête