Aller au contenu
signatik
Créer un compte

Identités

Identités attestées, réutilisables (signature avancée). Référence générée depuis les schémas de validation de l’API : ce que vous lisez est ce que le serveur vérifie.

Base : https://preprod-app.signatik.com/api/v1 · authentification Authorization: Bearer sk_… · erreurs { "error": { "code", "message" } }.

post/api/v1/identities

Établir une identité réutilisable

Mode partner_attested : vous avez vérifié la pièce, vous transmettez les attributs et l’empreinte du numéro (jamais le numéro). L’identité est réutilisable sur toutes les enveloppes suivantes du même signataire (identity_id). Scope identities:manage.

●POST /identities
curl -X POST https://preprod-app.signatik.com/api/v1/identities \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{
  "method": "partner_attested",
  "given_name": "Jean",
  "family_name": "Dupont",
  "birth_date": "1990-04-12",
  "email": "jean.dupont@exemple.fr",
  "phone": "+33612345678",
  "document_type": "id_card",
  "document_number_hash": "sha256:9f86d0…",
  "document_expires_on": "…",
  "verified_at": "2026-08-20T10:00:00Z",
  "verified_by": "Agence Lyon 3",
  "attestation_ref": "AG-2026-8891",
  "external_ref": "STG-8891",
  "expires_in_days": 1
}'
●201 — exemple de réponse
{
  "id": "8f2c1d4e-0b7a-4c1e-9f0d-6a3b2c1d0e9f",
  "method": "partner_attested",
  "status": "pending",
  "given_name": "Jean",
  "family_name": "Dupont",
  "birth_date": "1990-04-12",
  "email": "jean.dupont@exemple.fr",
  "phone": "+33612345678",
  "document_type": "…",
  "document_number_hash": "sha256:9f86d0…",
  "document_expires_on": "…",
  "verified_at": "2026-08-20T10:00:00Z",
  "verified_by": "Agence Lyon 3",
  "attestation_ref": "AG-2026-8891",
  "external_ref": "STG-8891",
  "expires_at": "2026-09-02T14:33:07Z",
  "created_at": "…",
  "verification_url": "…"
}
Corps de la requête
ChampTypeDescription
methodrequis"partner_attested" | "remote_id_check" | "france_identite"
given_namerequisstring≤ 100 car.
family_namerequisstring≤ 100 car.
birth_datestring
emailstring
phonestring≤ 30 car.
document_type"id_card" | "passport" | "residence_permit" | "driving_licence" | "other"
document_number_hashstring
document_expires_onstring
verified_atdate-time
verified_bystring≤ 200 car.
attestation_refstring≤ 200 car.
external_refstring≤ 200 car.
expires_in_daysinteger1–3650
Réponses
201OK
400Corps invalide
401Clé absente, mal formée ou révoquée (unauthorized)
403Scope manquant sur la clé (forbidden)
429Limitation de débit (rate_limited, en-tête Retry-After)
503idv_not_configured (vérification à distance non contractualisée)
Réponse 201
ChampTypeDescription
idrequisuuid
methodrequis"partner_attested" | "remote_id_check" | "france_identite"
statusrequis"pending" | "verified" | "failed" | "expired" | "deleted"
given_namerequisstring
family_namerequisstring
birth_daterequisstring | null
emailrequisstring | null
phonerequisstring | null
document_typerequisstring | null
document_number_hashrequisstring | nullEmpreinte sha256 du numéro de pièce — jamais le numéro
document_expires_onrequisstring | null
verified_atrequisdate-time | null
verified_byrequisstring | null
attestation_refrequisstring | null
external_refrequisstring | null
expires_atrequisdate-time | null
created_atrequisstring
verification_urlrequisstring | null
get/api/v1/identities

Lister les identités

●GET /identities
curl -X GET https://preprod-app.signatik.com/api/v1/identities \
  -H "Authorization: Bearer sk_test_…"
●200 — exemple de réponse
{
  "data": [
    {
      "id": "8f2c1d4e-0b7a-4c1e-9f0d-6a3b2c1d0e9f",
      "method": "partner_attested",
      "status": "pending",
      "given_name": "Jean",
      "family_name": "Dupont",
      "birth_date": "1990-04-12",
      "email": "jean.dupont@exemple.fr",
      "phone": "+33612345678",
      "document_type": "…",
      "document_number_hash": "sha256:9f86d0…",
      "document_expires_on": "…",
      "verified_at": "2026-08-20T10:00:00Z",
      "verified_by": "Agence Lyon 3",
      "attestation_ref": "AG-2026-8891",
      "external_ref": "STG-8891",
      "expires_at": "2026-09-02T14:33:07Z",
      "created_at": "…"
    }
  ],
  "limit": 1,
  "offset": 1
}
Paramètres de requête
limitinteger
offsetinteger | null
external_refstring
Réponses
200OK
401Clé absente, mal formée ou révoquée (unauthorized)
403Scope manquant sur la clé (forbidden)
429Limitation de débit (rate_limited, en-tête Retry-After)
Réponse 200
ChampTypeDescription
datarequisIdentity[]
idrequisuuid
methodrequis"partner_attested" | "remote_id_check" | "france_identite"
statusrequis"pending" | "verified" | "failed" | "expired" | "deleted"
given_namerequisstring
family_namerequisstring
birth_daterequisstring | null
emailrequisstring | null
phonerequisstring | null
document_typerequisstring | null
document_number_hashrequisstring | nullEmpreinte sha256 du numéro de pièce — jamais le numéro
document_expires_onrequisstring | null
verified_atrequisdate-time | null
verified_byrequisstring | null
attestation_refrequisstring | null
external_refrequisstring | null
expires_atrequisdate-time | null
created_atrequisstring
limitrequisnumber
offsetrequisnumber
get/api/v1/identities/{id}

Lire une identité

●GET /identities/{id}
curl -X GET https://preprod-app.signatik.com/api/v1/identities/env_8f2c… \
  -H "Authorization: Bearer sk_test_…"
●200 — exemple de réponse
{
  "id": "8f2c1d4e-0b7a-4c1e-9f0d-6a3b2c1d0e9f",
  "method": "partner_attested",
  "status": "pending",
  "given_name": "Jean",
  "family_name": "Dupont",
  "birth_date": "1990-04-12",
  "email": "jean.dupont@exemple.fr",
  "phone": "+33612345678",
  "document_type": "…",
  "document_number_hash": "sha256:9f86d0…",
  "document_expires_on": "…",
  "verified_at": "2026-08-20T10:00:00Z",
  "verified_by": "Agence Lyon 3",
  "attestation_ref": "AG-2026-8891",
  "external_ref": "STG-8891",
  "expires_at": "2026-09-02T14:33:07Z",
  "created_at": "…"
}
Paramètres de chemin
iduuid
Réponses
200OK
401Clé absente, mal formée ou révoquée (unauthorized)
403Scope manquant sur la clé (forbidden)
404Introuvable
429Limitation de débit (rate_limited, en-tête Retry-After)
Réponse 200
ChampTypeDescription
idrequisuuid
methodrequis"partner_attested" | "remote_id_check" | "france_identite"
statusrequis"pending" | "verified" | "failed" | "expired" | "deleted"
given_namerequisstring
family_namerequisstring
birth_daterequisstring | null
emailrequisstring | null
phonerequisstring | null
document_typerequisstring | null
document_number_hashrequisstring | nullEmpreinte sha256 du numéro de pièce — jamais le numéro
document_expires_onrequisstring | null
verified_atrequisdate-time | null
verified_byrequisstring | null
attestation_refrequisstring | null
external_refrequisstring | null
expires_atrequisdate-time | null
created_atrequisstring
delete/api/v1/identities/{id}

Effacer une identité (droit à l’effacement)

Les signatures déjà émises restent valides : la preuve est dans le certificat et le dossier de preuve.

●DELETE /identities/{id}
curl -X DELETE https://preprod-app.signatik.com/api/v1/identities/env_8f2c… \
  -H "Authorization: Bearer sk_test_…"
●200 — exemple de réponse
{
  "deleted": true
}
Paramètres de chemin
iduuid
Réponses
200OK
401Clé absente, mal formée ou révoquée (unauthorized)
403Scope manquant sur la clé (forbidden)
404Introuvable
429Limitation de débit (rate_limited, en-tête Retry-After)
Réponse 200
ChampTypeDescription
deletedrequistrue