Skip to content

Seqino PDP API (1.0.0)

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

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://pdp.seqino.dev/

Languages
Servers
Dev server

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

Local development server

http://localhost:8052/

👥 Clients

Operations

📋 Get all clients

Request

Get all clients with their details.

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

Responses

List of all clients

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

➕ 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.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.​client_idstring(Client Id)

Unique client identifier

client.​organization_namestring(Organization Name)required

Name of the organization

client.​contact_emailstring(Contact Email)required

Contact email for the organization

client.​external_refstring(External Ref)required

External reference identifier

client.​sponsor_idstring(Sponsor Id)required

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

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

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)required

Response message

Example: "Client created successfully"
Response
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

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.

Path
client_idstring(Client Id)required
curl -i -X DELETE \
  'https://pdp.seqino.dev/api/clients/{client_id}'

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.

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

➕ 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)
Example: "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 '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