Ce endpoint de l'API permet de forcer le statut de complétude et de conformité d'un document
Description
La description complète est accessible sur notre swagger
Méthode
POST
Paramètres
|
Param |
Type |
Description |
Exemple |
|---|---|---|---|
|
selectCompanyId |
string |
Identifiant de la société à utiliser si l’utilisateur a accès à plusieurs sociétés |
|
|
externalRef |
string/string |
Source de données/id externe d'une personne La source de donnée peut être de la forme technique ou le nom de la source |
|
Body
Valeurs possibles pour le statut de complétude
|
Valeur |
Description |
|---|---|
|
MISSING |
Document manquant |
|
OUTDATED |
Document à mettre à jour |
|
TO_CHECK |
Document à vérifier |
|
UP_TO_DATE |
Document à jour |
|
NOT_SUITABLE |
Non renseigné |
|
IN_PROGRESS |
Ne pas utiliser |
Valeurs possibles pour le statut de conformité
|
Valeur |
Description |
|---|---|
|
MISSING |
Document manquant |
|
CONFORMS |
Document conforme |
|
NOT_CONFORMS |
Document non conforme |
|
PARTIAL_CONFORMS |
Document conforme avec réserve |
|
NOT_SUITABLE |
Non renseigné |
Réponse
Exemple de réponse obtenue après la mise à jour des statuts d’un document
{
"id": "5a155052c2dcee2eccb26c99",
"path": "Salariés/Jean Dupont/Attestation d’honorabilité",
"completenessStatus": {
"type":"TO_CHECK",
"date": "2017-11-23T09:55:43.726Z",
"forced": true
},
"conformityStatus": {
"type":"TO_CHECK",
"date": "2017-11-23T09:55:43.726Z",
"forced": true
},
"upToDateDate": "2017-11-22T10:24:18.019Z",
"expirationDate": "2018-11-22T09:55:43.726Z",
"blobIds": ["5a155052c2dcee2eccb26c99"],
"statusComment": "Un commentaire"
}