Aller au contenu

Signer un EDL (ancrage NF203, hash contenu)

POST
/v1/inspections/{id}/sign
curl --request POST \
--url https://example.com/v1/inspections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/sign \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "mode": "bilateral", "modeReason": "example", "signatures": [ { "role": "inspector", "signatoryName": "example", "payloadRef": "example" } ] }'
id
required
string format: uuid
Media type application/json
object
mode
required
string
Allowed values: bilateral unilateral_staff refusal_noted
modeReason
string
nullable <= 500 characters
signatures
required
Array<object>
>= 1 items <= 5 items
object
role
required
string
Allowed values: inspector guest witness
signatoryName
required
string
<= 200 characters
payloadRef
required
string
<= 512 characters

EDL signé

Media type application/json
object
data
required
object
contentHash
required

Hash NF203 du contenu signé

string
Example generated
{
"data": {
"contentHash": "example"
}
}

Corps invalide

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}

Non authentifié

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}

Permission refusée

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}

EDL introuvable

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}

EDL non finalisé

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}