Passer au contenu
/
📋 Get all clients

Seqino PDP API (1.0.0)

Seqino PDP API - Modern interface to France's e-Invoicing services

Télécharger la description d'OpenAPI
openapi.json
openapi.yaml
Aperçu
URL

https://pdp.seqino.dev/

Langues
Serveurs
Dev server for Beta Testers

https://pdp.seqino.dev/api/

👥 Clients

Manage clients

Opérations

📋 Get all clients

Requête

Get all clients with their details.

Sécurité
APIKeyHeader
curl -i -X GET \
  https://pdp.seqino.dev/api/clients \
  -H 'Authorization: YOUR_API_KEY_HERE'

Réponses

List of all clients

Corpsapplication/jsonArray [
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
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)
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"
  }
]

➕ Create a new client

Requête

Create a new client with the provided details.

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
clientobject(Client)obligatoire
client.​client_idstring(Client Id)

Unique client identifier

client.​organization_namestring(Organization Name)obligatoire

Name of the organization

client.​contact_emailstring(Contact Email)obligatoire

Contact email for the organization

client.​external_refstring(External Ref)obligatoire

External reference identifier

client.​sponsor_idstring(Sponsor Id)obligatoire

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

client.​statusstring(ClientStatus)obligatoire
Enum"active""inactive""pending""suspended"
client.​created_atstring(date-time)(Created At)obligatoire

When the client was created

client.​updated_atUpdated At (string) or Updated At (null)(Updated At)
Any of:

When the client was last updated

string(date-time)(Updated At)
messagestring(Message)obligatoire

Response message

Exemple: "Client created successfully"
Réponse
application/json
{
  "client": {
    "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"
  },
  "message": "Client created successfully"
}

🗑️ 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)
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)
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"
}

➕ Create new PDP client

Requête

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.

Sécurité
APIKeyHeader
Corpsapplication/jsonobligatoire
external_referencestring(External Reference)obligatoire

External reference to associate with the PDP client

Exemple: "CUST-12345"
client_namestring(Client Name)obligatoire

Human-readable name for the client

Exemple: "ACME Corporation"
descriptionDescription (string) or Description (null)(Description)
Exemple: "Main client for ACME Corp operations"
Any of:

Optional description of the client

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

Réponses

PDP client created successfully

Corpsapplication/json
pdp_client_idstring(Pdp Client Id)obligatoire

Generated PDP client ID

Exemple: "pdp_abc123def456"
external_referencestring(External Reference)obligatoire

Associated external reference

Exemple: "CUST-12345"
client_namestring(Client Name)obligatoire

Client name

Exemple: "ACME Corporation"
statusstring(Status)obligatoire

Client status

Exemple: "active"
created_atstring(date-time)(Created At)obligatoire

Creation timestamp

messagestring(Message)obligatoire

Success message

Réponse
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"
}

📘 Directory

Directory operations

Opérations

📝 Drafts

Create and validate invoice drafts

Opérations

🧾 Invoicing

Send and receive electronic invoices

Opérations

🔄 Lifecycle

Polls or subscribes to lifecycle events

Opérations

📋 Mandates

Manage legal entities and PPF directory entries

Opérations

📊 Reporting

Send e-reporting information

Opérations

⚙️ Settings

Configure client preferences

Opérations

📊 Usage

Gather API usage per client and invoice

Opérations

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