Connectez votre logiciel
à VerifCV.Connect your software
to VerifCV.
https://api.verifcv.comUne intégration, de bout en boutAn end-to-end integration
L’API VerifCV permet à votre logiciel de déposer des dossiers, de consulter les vérifications et de récupérer les documents et rapports.The VerifCV API lets your software submit cases, read verification results and retrieve documents and reports.
Se connecterAuthenticate
Identifiants, authentification OAuth 2.0 et jeton Bearer.Credentials, OAuth 2.0 authentication and Bearer token.
02Déposer un dossierSubmit a case
Profils, informations candidat et documents.Profiles, candidate information and documents.
03Suivre les vérificationsTrack verifications
Statuts, historique, synchronisation et téléchargement des rapports.Statuses, history, synchronization and report downloads.
Environnements et conventionsEnvironments and conventions
| EnvironnementEnvironment | Base URL | UtilisationUsage |
|---|---|---|
| Sandbox / Test | https://api.test.verifcv.com | Tests d’intégration avec des données fictives.Integration testing with fictional data. |
| Production | https://api.verifcv.com | Dépôt et suivi des dossiers réels.Submission and tracking of live cases. |
Formats et langueFormats and language
| ConventionConvention | RègleRule |
|---|---|
| RéponsesResponses | JSON encodé en UTF-8. Les téléchargements renvoient directement le fichier.UTF-8 JSON. Downloads return the file directly. |
| DatesDates | Dates de naissance et d’embauche au format YYYY-MM-DD. Les horodatages sont en secondes Unix UTC.Birth and hiring dates use YYYY-MM-DD. Timestamps use Unix seconds (UTC). |
| Routes et champsRoutes and fields | Les noms des routes et des champs sont en anglais.Route and field names are in English. |
| LibellésLabels | Accept-Language: fr (par défaut) ou en sélectionne la langue des libellés de restitution. Les noms des profils et des points restent ceux configurés dans VerifCV.Accept-Language: fr (default) or en selects response label language. Profile and check names retain their configured VerifCV names. |
Chaque environnement possède ses propres identifiants. Le sélecteur en haut ouvre la documentation de l’environnement choisi.Each environment has separate credentials. The selector above opens the documentation for the chosen environment.
Accès à l’APIAPI access
Prérequis : disposer d’un client_id et d’un client_secret fournis par VerifCV pour l’environnement choisi. Chaque exemple propose trois vues : cURL pour le terminal, PHP avec l’extension cURL et HTTP pour lire la requête indépendamment du langage.Requirements: a client_id and client_secret issued by VerifCV for the chosen environment. Each example provides three views: terminal cURL, PHP using the cURL extension, and HTTP for a language-independent view of the request.
Conservez le client_secret côté serveur. Après authentification OAuth 2.0, transmettez le jeton reçu dans l’en-tête Authorization: Bearer de chaque appel métier.Keep client_secret server-side. After OAuth 2.0 authentication, send the returned token in the Authorization: Bearer header of each business request.
Les variables CLIENT_ID, CLIENT_SECRET, ACCESS_TOKEN et IDEMPOTENCY_KEY représentent les valeurs de votre intégration et de votre opération. Les exemples PHP les lisent depuis les variables d’environnement du serveur et utilisent les fichiers du même répertoire que le script.CLIENT_ID, CLIENT_SECRET, ACCESS_TOKEN and IDEMPOTENCY_KEY represent the values for your integration and operation. PHP examples read them from server environment variables and use files in the script’s directory.
Obtenir un jetonGet an access token
/oauth/tokenUtilisez vos identifiants API de l’environnement choisi pour obtenir un jeton OAuth 2.0 avec le flux client_credentials. Le jeton est valable 15 minutes. Réutilisez-le jusqu’à expiration, puis demandez-en un nouveau avec les mêmes identifiants.Use your API credentials for the selected environment to obtain an OAuth 2.0 token with the client_credentials grant. The token is valid for 15 minutes. Reuse it until it expires, then request a new one with the same credentials.
| ChampField | Type / obligationType / requirement | DescriptionDescription |
|---|---|---|
| Authorization | Header · requisrequired | Authentification HTTP Basic avec votre client_id et votre client_secret. Utilisez la fonction d’authentification Basic de votre bibliothèque HTTP.HTTP Basic authentication with your client_id and client_secret. Use your HTTP library’s Basic authentication feature. |
| grant_type | Body form · requisrequired | client_credentials |
Exemple de requêteRequest example
curl --fail-with-body --request POST "https://api.verifcv.com/oauth/token" \
--user "$CLIENT_ID:$CLIENT_SECRET" \
--header "Content-Type: application/x-www-form-urlencoded" \
--data-urlencode "grant_type=client_credentials"<?php
$CLIENT_ID = getenv('CLIENT_ID');
$CLIENT_SECRET = getenv('CLIENT_SECRET');
$ch = curl_init('https://api.verifcv.com/oauth/token');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
CURLOPT_USERPWD => $CLIENT_ID . ':' . $CLIENT_SECRET,
CURLOPT_HTTPHEADER => [
'Content-Type: application/x-www-form-urlencoded',
],
CURLOPT_POSTFIELDS => http_build_query([
'grant_type' => 'client_credentials',
], '', '&', PHP_QUERY_RFC3986),
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
echo $response;POST https://api.verifcv.com/oauth/token HTTP/1.1
Host: api.verifcv.com
Authorization: Basic <base64(CLIENT_ID:CLIENT_SECRET)>
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentialsExemples de réponseResponse examples
{
"access_token": "EXAMPLE_ACCESS_TOKEN",
"token_type": "Bearer",
"expires_in": 900
}{
"error": "invalid_client",
"error_description": "Client authentication failed."
}{
"error": "unsupported_grant_type",
"error_description": "Only client_credentials is supported."
}Structure complète de la réponse et codes HTTPFull response structure and HTTP codes
| ChampField | TypeType | Toujours présentAlways present | DescriptionDescription |
|---|---|---|---|
access_token | string | OuiYes | Jeton à envoyer dans l’en-tête Authorization: Bearer.Token to send in the Authorization: Bearer header. |
token_type | string | OuiYes | Type du jeton. La valeur est toujours Bearer.Token type. Always Bearer. Bearer |
expires_in | integer | OuiYes | Durée de validité du jeton, en secondes.Token lifetime in seconds. 900 |
| HTTP | SignificationMeaning |
|---|---|
| 200 | Requête réussie.Success |
| 400 | Requête invalide. Consultez le message d’erreur.OAuth request error |
| 401 | Identifiants API invalides.Invalid client |
| 429 | Trop de requêtes. Retry-After indique le délai d’attente en secondes.Rate limited |
| 503 | Service temporairement indisponible.Unavailable |
Révoquer un jetonRevoke a token
/oauth/revokeUtilisez la même authentification Basic que pour obtenir un jeton. Le jeton devient inutilisable immédiatement. Un jeton inconnu retourne également 200, sans contenu.Use the same Basic authentication as for token issuance. The token becomes unusable immediately. An unknown token also returns an empty 200 response.
| ChampField | Type / obligationType / requirement | DescriptionDescription |
|---|---|---|
| Authorization | Header · requisrequired | Authentification HTTP Basic avec votre client_id et votre client_secret. Utilisez la fonction d’authentification Basic de votre bibliothèque HTTP.HTTP Basic authentication with your client_id and client_secret. Use your HTTP library’s Basic authentication feature. |
| token | Body form · requisrequired | Jeton à révoquer, appartenant à cette intégration.Token to revoke, owned by this integration. |
Exemple de requêteRequest example
curl --fail-with-body --request POST "https://api.verifcv.com/oauth/revoke" \
--user "$CLIENT_ID:$CLIENT_SECRET" \
--header "Content-Type: application/x-www-form-urlencoded" \
--data-urlencode "token=$ACCESS_TOKEN"<?php
$CLIENT_ID = getenv('CLIENT_ID');
$CLIENT_SECRET = getenv('CLIENT_SECRET');
$ACCESS_TOKEN = getenv('ACCESS_TOKEN');
$ch = curl_init('https://api.verifcv.com/oauth/revoke');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
CURLOPT_USERPWD => $CLIENT_ID . ':' . $CLIENT_SECRET,
CURLOPT_HTTPHEADER => [
'Content-Type: application/x-www-form-urlencoded',
],
CURLOPT_POSTFIELDS => http_build_query([
'token' => $ACCESS_TOKEN,
], '', '&', PHP_QUERY_RFC3986),
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
echo $response;POST https://api.verifcv.com/oauth/revoke HTTP/1.1
Host: api.verifcv.com
Authorization: Basic <base64(CLIENT_ID:CLIENT_SECRET)>
Content-Type: application/x-www-form-urlencoded
token=<ACCESS_TOKEN>Exemples de réponseResponse examples
HTTP/1.1 200 OK
{
"error": "invalid_client",
"error_description": "Client authentication failed."
}{
"error": "invalid_request",
"error_description": "token is required."
}Structure complète de la réponse et codes HTTPFull response structure and HTTP codes
| HTTP | SignificationMeaning |
|---|---|
| 200 | Jeton révoqué ou déjà inconnu. La réponse est vide.Revoked or unknown token |
| 400 | Requête invalide. Consultez le message d’erreur.OAuth request error |
| 401 | Identifiants API invalides.Invalid client |
| 429 | Trop de requêtes. Retry-After indique le délai d’attente en secondes.Rate limited |
| 503 | Service temporairement indisponible.Unavailable |
Lister les déposantsList submitters
/v1/submittersListe les comptes autorisés à déposer via cette intégration. Le compte default est utilisé si submitter_id est omis. Les droits de consultation restent ceux du compte de référence.Lists accounts authorized to submit through this integration. The default account is used when submitter_id is omitted. Read permissions remain those of the reference account.
Exemple de requêteRequest example
curl --fail-with-body --request GET "https://api.verifcv.com/v1/submitters" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Accept: application/json"<?php
$ACCESS_TOKEN = getenv('ACCESS_TOKEN');
$ch = curl_init('https://api.verifcv.com/v1/submitters');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $ACCESS_TOKEN,
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
echo $response;GET https://api.verifcv.com/v1/submitters HTTP/1.1
Host: api.verifcv.com
Authorization: Bearer <ACCESS_TOKEN>
Accept: application/jsonExemples de réponseResponse examples
{
"data": [
{
"id": 12,
"name": "Compte principal",
"default": true,
"can_deposit_confidential": true
},
{
"id": 34,
"name": "Compte supplémentaire",
"default": false,
"can_deposit_confidential": false
}
]
}{
"error": {
"code": "invalid_token",
"message": "A valid access token is required.",
"details": [],
"request_id": "req_f2d8513f9398085fc3c27baa1bb6b9fd"
}
}Structure complète de la réponse et codes HTTPFull response structure and HTTP codes
| ChampField | TypeType | Toujours présentAlways present | DescriptionDescription |
|---|---|---|---|
data | object[] | OuiYes | Liste des déposants autorisés.List of permitted submitters. |
data[]. | integer | OuiYes | Identifiant du déposant.Identifier of the submitting account. |
data[]. | string | OuiYes | Nom du compte déposant.Submitting account name. |
data[]. | boolean | OuiYes | Si true, ce compte est utilisé lorsque submitter_id est omis.If true, this account is used when submitter_id is omitted. |
data[]. | boolean | OuiYes | Indique si cet accès API permet un dépôt confidentiel pour ce compte. Toujours false pour les déposants supplémentaires.Whether this API access can submit a confidential case for this account. Always false for additional submitters. |
| HTTP | SignificationMeaning |
|---|---|
| 200 | Requête réussie.Success |
| 400 | Requête invalide. Consultez le message d’erreur.Request rejected |
| 401 | Jeton absent, invalide ou expiré.Missing or invalid token |
| 403 | Cet accès ne permet pas cette opération.Operation not allowed |
| 404 | Ressource introuvable ou inaccessible à ce compte.Resource absent or outside account scope |
| 409 | La requête entre en conflit avec une opération ou un état existant.Request rejected |
| 413 | Le contenu envoyé dépasse la taille autorisée.Request rejected |
| 415 | Le format envoyé n’est pas accepté.Request rejected |
| 422 | Une ou plusieurs données sont invalides. Consultez les détails de l’erreur.Request rejected |
| 429 | Trop de requêtes. Retry-After indique le délai d’attente en secondes.Rate limit reached. Retry-After is in seconds |
| 503 | Service temporairement indisponible.Temporarily unavailable. no partial creation |
Découvrir les profils et obligationsDiscover profiles and requirements
/v1/profilesRetourne tous les profils du groupe avec leurs points et obligations. Sans profil, la réponse fournit la configuration de base dans default_configuration. Un seul appel suffit pour préparer le dépôt.Returns all group profiles with their checks and requirements. When no profile exists, default_configuration contains the group’s base configuration. One request provides the configuration needed for submission.
Exemple de requêteRequest example
curl --fail-with-body --request GET "https://api.verifcv.com/v1/profiles" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Accept: application/json"<?php
$ACCESS_TOKEN = getenv('ACCESS_TOKEN');
$ch = curl_init('https://api.verifcv.com/v1/profiles');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $ACCESS_TOKEN,
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
echo $response;GET https://api.verifcv.com/v1/profiles HTTP/1.1
Host: api.verifcv.com
Authorization: Bearer <ACCESS_TOKEN>
Accept: application/jsonQuel profil utiliser pour créer un dossier ?Which profile should you use to create a case?
La réponse indique si votre groupe utilise des profils ou sa configuration de base. profile_required est une information renvoyée par l’API, pas un paramètre à envoyer.The response tells you whether your group uses profiles or its base configuration. profile_required is information returned by the API, not a request parameter.
| Votre groupeYour group | Valeur renvoyéeReturned value | Pour créer le dossierTo create the case |
|---|---|---|
| Groupe avec profilsGroup with profiles | profile_required: true | Choisissez un profil dans data : ses points et obligations sont inclus. À la création du dossier, envoyez son id dans profile_id. L’appel GET /v1/profiles/{profile_id} reste facultatif pour consulter un seul profil.Choose a profile from data: its checks and requirements are included. When creating the case, send its id as profile_id. GET /v1/profiles/{profile_id} remains optional to retrieve a single profile. |
| Groupe sans profilGroup without profiles | profile_required: false | Le dossier utilise la configuration de base du groupe. Ses points et obligations figurent dans default_configuration. Créez le dossier sans envoyer profile_id.The case uses the group’s base configuration. Its checks and requirements are provided in default_configuration. Create the case without sending profile_id. |
Exemples de réponseResponse examples
{
"data": [
{
"id": 42,
"name": "Profil exemple 1",
"points": [
{
"point_id": 4,
"id_type": 1,
"type": "Autorisation",
"label": "Demande autorisation",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
},
{
"point_id": 5,
"id_type": 2,
"type": "Identité",
"label": "Pièce d’identité",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
},
{
"point_id": 6,
"id_type": 3,
"type": "Diplôme",
"label": "Diplôme 1",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
},
{
"point_id": 7,
"id_type": 3,
"type": "Diplôme",
"label": "Diplôme 2",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
},
{
"point_id": 9,
"id_type": 4,
"type": "Prise de référence",
"label": "Prise de référence 1",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
}
],
"required_candidate_fields": []
},
{
"id": 43,
"name": "Profil exemple 2",
"points": [
{
"point_id": 4,
"id_type": 1,
"type": "Autorisation",
"label": "Demande autorisation",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
},
{
"point_id": 17,
"id_type": 5,
"type": "Casier judiciaire",
"label": "Casier judiciaire",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
},
{
"point_id": 6,
"id_type": 3,
"type": "Diplôme",
"label": "Diplôme 1",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
}
],
"required_candidate_fields": []
}
],
"profile_required": true,
"general_documents_allowed": true,
"default_configuration": null
}{
"data": [],
"profile_required": false,
"general_documents_allowed": true,
"default_configuration": {
"points": [
{
"point_id": 4,
"id_type": 1,
"type": "Autorisation",
"label": "Demande autorisation",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
},
{
"point_id": 5,
"id_type": 2,
"type": "Identité",
"label": "Pièce d’identité",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
},
{
"point_id": 6,
"id_type": 3,
"type": "Diplôme",
"label": "Diplôme 1",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
},
{
"point_id": 9,
"id_type": 4,
"type": "Prise de référence",
"label": "Prise de référence 1",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
},
{
"point_id": 10,
"id_type": 4,
"type": "Prise de référence",
"label": "Prise de référence 2",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
}
],
"required_candidate_fields": [
"email"
]
}
}{
"error": {
"code": "validation_failed",
"message": "Unknown fields.",
"details": [
{
"field": "submitter_id",
"code": "unknown_field"
}
],
"request_id": "req_5348e6d633247b89390bb12c096dfbd7"
}
}Structure complète de la réponse et codes HTTPFull response structure and HTTP codes
| ChampField | TypeType | Toujours présentAlways present | DescriptionDescription |
|---|---|---|---|
data | object[] | OuiYes | Profils disponibles avec leurs points. Liste vide si le groupe utilise sa configuration de base.Available profiles with their checks. Empty when the group uses its base configuration. |
data[]. | integer | OuiYes | Identifiant du profil.Identifier of the profile. |
data[]. | string | OuiYes | Nom du profil configuré dans VerifCV.Profile name configured in VerifCV. |
data[]. | object[] | OuiYes | Points de vérification appliqués au dossier, dans l’ordre de l’application client.Checks applied to the case, in client application order. |
data[]. | string | OuiYes | Nom du point configuré, par exemple Diplôme 1.Configured point name, for example Diploma 1. |
data[]. | boolean | OuiYes | Indique si un document peut être joint à ce point lors du dépôt.Whether a document can be attached to this point on submission. |
data[]. | boolean | OuiYes | Indique si un document doit être joint à ce point lors du dépôt.Whether a document must be attached to this point on submission. |
data[]. | string[] | OuiYes | Extensions de fichiers acceptées pour ce point.File extensions accepted for this point. |
data[]. | integer | OuiYes | Identifiant du point dans le catalogue. À utiliser pour lui associer un document lors du dépôt.Catalogue point ID. Use it to attach a document to this point on submission. |
data[]. | integer / null | OuiYes | Identifiant du type de vérification. Plusieurs points peuvent avoir le même type.Verification type ID. Several checks can share the same type. |
data[]. | string / null | OuiYes | Nom du type de vérification. Vaut null si aucun type n’est associé.Verification type name. Null when no type is linked. |
data[]. | string[] | OuiYes | Champs candidat obligatoires au dépôt. Une liste vide signifie qu’aucun champ supplémentaire n’est imposé.Candidate fields required on submission. An empty list means no additional field is required. Voir les champs candidat.View candidate fields. |
profile_required | boolean | NonNo | Si true, choisissez un profil dans data et envoyez son id dans profile_id à la création.If true, choose a profile from data and send its ID as profile_id on creation. |
default_configuration | object / null | NonNo | Configuration de base du groupe quand aucun profil n’existe. Vaut null lorsque des profils sont proposés.Group base configuration when no profile exists. Null when profiles are available. |
default_configuration. | object[] | OuiYes | Points de vérification appliqués au dossier, dans l’ordre de l’application client.Checks applied to the case, in client application order. |
default_configuration. | string | OuiYes | Nom du point configuré, par exemple Diplôme 1.Configured point name, for example Diploma 1. |
default_configuration. | boolean | OuiYes | Indique si un document peut être joint à ce point lors du dépôt.Whether a document can be attached to this point on submission. |
default_configuration. | boolean | OuiYes | Indique si un document doit être joint à ce point lors du dépôt.Whether a document must be attached to this point on submission. |
default_configuration. | string[] | OuiYes | Extensions de fichiers acceptées pour ce point.File extensions accepted for this point. |
default_configuration. | integer | OuiYes | Identifiant du point dans le catalogue. À utiliser pour lui associer un document lors du dépôt.Catalogue point ID. Use it to attach a document to this point on submission. |
default_configuration. | integer / null | OuiYes | Identifiant du type de vérification. Plusieurs points peuvent avoir le même type.Verification type ID. Several checks can share the same type. |
default_configuration. | string / null | OuiYes | Nom du type de vérification. Vaut null si aucun type n’est associé.Verification type name. Null when no type is linked. |
default_configuration. | string[] | OuiYes | Champs candidat obligatoires au dépôt. Une liste vide signifie qu’aucun champ supplémentaire n’est imposé.Candidate fields required on submission. An empty list means no additional field is required. Voir les champs candidat.View candidate fields. |
general_documents_allowed | boolean | OuiYes | Autorise les documents complémentaires avec kind: general. Ne concerne pas les pièces liées à un point de vérification.Allows supplementary documents with kind: general. Does not affect documents attached to a verification point. |
| HTTP | SignificationMeaning |
|---|---|
| 200 | Requête réussie.Success |
| 400 | Requête invalide. Consultez le message d’erreur.Request rejected |
| 401 | Jeton absent, invalide ou expiré.Missing or invalid token |
| 403 | Cet accès ne permet pas cette opération.Operation not allowed |
| 404 | Ressource introuvable ou inaccessible à ce compte.Resource absent or outside account scope |
| 409 | La requête entre en conflit avec une opération ou un état existant.Request rejected |
| 413 | Le contenu envoyé dépasse la taille autorisée.Request rejected |
| 415 | Le format envoyé n’est pas accepté.Request rejected |
| 422 | Une ou plusieurs données sont invalides. Consultez les détails de l’erreur.Request rejected |
| 429 | Trop de requêtes. Retry-After indique le délai d’attente en secondes.Rate limit reached. Retry-After is in seconds |
| 503 | Service temporairement indisponible.Temporarily unavailable. no partial creation |
Consulter un profilRead a profile
/v1/profiles/{profile_id}Retourne les points et les obligations du profil, dans l’ordre de l’application client. Tous les points du profil sont appliqués à la création du dossier.Returns profile checks and requirements in client application order. All configured profile checks are applied when creating the case.
| ChampField | Type / obligationType / requirement | DescriptionDescription |
|---|---|---|
profile_id | path · integer · requisrequired | Identifiant du profil retourné dans data[].id par GET /v1/profiles.Profile ID returned in data[].id by GET /v1/profiles. |
Exemple de requêteRequest example
curl --fail-with-body --request GET "https://api.verifcv.com/v1/profiles/42" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Accept: application/json"<?php
$ACCESS_TOKEN = getenv('ACCESS_TOKEN');
$ch = curl_init('https://api.verifcv.com/v1/profiles/42');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $ACCESS_TOKEN,
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
echo $response;GET https://api.verifcv.com/v1/profiles/42 HTTP/1.1
Host: api.verifcv.com
Authorization: Bearer <ACCESS_TOKEN>
Accept: application/jsonExemples de réponseResponse examples
{
"id": 42,
"name": "Profil exemple 1",
"points": [
{
"point_id": 4,
"id_type": 1,
"type": "Autorisation",
"label": "Demande autorisation",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
},
{
"point_id": 5,
"id_type": 2,
"type": "Identité",
"label": "Pièce d’identité",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
},
{
"point_id": 6,
"id_type": 3,
"type": "Diplôme",
"label": "Diplôme 1",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
},
{
"point_id": 7,
"id_type": 3,
"type": "Diplôme",
"label": "Diplôme 2",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
},
{
"point_id": 9,
"id_type": 4,
"type": "Prise de référence",
"label": "Prise de référence 1",
"document_allowed": true,
"document_required": false,
"accepted_extensions": [
"pdf",
"jpg",
"jpeg",
"png",
"gif",
"txt",
"rtf",
"doc",
"docx",
"odt"
]
}
],
"required_candidate_fields": []
}{
"error": {
"code": "not_found",
"message": "Profile not found.",
"details": [],
"request_id": "req_8d9d47f8e9ca0bec566278e2a2c6d97b"
}
}Consulter la référence des identifiants : profil, point du catalogue, vérification du dossier et document.See the identifier reference: profile, catalogue slot, case verification and document.
Structure complète de la réponse et codes HTTPFull response structure and HTTP codes
| ChampField | TypeType | Toujours présentAlways present | DescriptionDescription |
|---|---|---|---|
id | integer | OuiYes | Identifiant du profil.Identifier of the profile. |
name | string | OuiYes | Nom du profil configuré dans VerifCV.Profile name configured in VerifCV. |
points | object[] | OuiYes | Points de vérification appliqués au dossier, dans l’ordre de l’application client.Checks applied to the case, in client application order. |
points[]. | string | OuiYes | Nom du point configuré, par exemple Diplôme 1.Configured point name, for example Diploma 1. |
points[]. | boolean | OuiYes | Indique si un document peut être joint à ce point lors du dépôt.Whether a document can be attached to this point on submission. |
points[]. | boolean | OuiYes | Indique si un document doit être joint à ce point lors du dépôt.Whether a document must be attached to this point on submission. |
points[]. | string[] | OuiYes | Extensions de fichiers acceptées pour ce point.File extensions accepted for this point. |
points[]. | integer | OuiYes | Identifiant du point dans le catalogue. À utiliser pour lui associer un document lors du dépôt.Catalogue point ID. Use it to attach a document to this point on submission. |
points[]. | integer / null | OuiYes | Identifiant du type de vérification. Plusieurs points peuvent avoir le même type.Verification type ID. Several checks can share the same type. |
points[]. | string / null | OuiYes | Nom du type de vérification. Vaut null si aucun type n’est associé.Verification type name. Null when no type is linked. |
required_candidate_fields | string[] | OuiYes | Champs candidat obligatoires au dépôt. Une liste vide signifie qu’aucun champ supplémentaire n’est imposé.Candidate fields required on submission. An empty list means no additional field is required. Voir les champs candidat.View candidate fields. |
| HTTP | SignificationMeaning |
|---|---|
| 200 | Requête réussie.Success |
| 400 | Requête invalide. Consultez le message d’erreur.Request rejected |
| 401 | Jeton absent, invalide ou expiré.Missing or invalid token |
| 403 | Cet accès ne permet pas cette opération.Operation not allowed |
| 404 | Ressource introuvable ou inaccessible à ce compte.Resource absent or outside account scope |
| 409 | La requête entre en conflit avec une opération ou un état existant.Request rejected |
| 413 | Le contenu envoyé dépasse la taille autorisée.Request rejected |
| 415 | Le format envoyé n’est pas accepté.Request rejected |
| 422 | Une ou plusieurs données sont invalides. Consultez les détails de l’erreur.Request rejected |
| 429 | Trop de requêtes. Retry-After indique le délai d’attente en secondes.Rate limit reached. Retry-After is in seconds |
| 503 | Service temporairement indisponible.Temporarily unavailable. no partial creation |
Créer un dossierCreate a case
/v1/casesCrée un dossier à partir des informations candidat et du document principal. Envoyez les données JSON et les fichiers dans une seule requête multipart/form-data. Par défaut, le document principal est un CV et le dépôt est affecté au déposant par défaut.Creates a case from candidate information and a primary document. Send JSON data and files in a single multipart/form-data request. By default, the primary document is a CV and the case is assigned to the default submitter.
| ChampField | Type / obligationType / requirement | DescriptionDescription |
|---|---|---|
Idempotency-Key | header · string · requisrequired | Clé de 16 à 128 caractères : lettres ASCII, chiffres et . _ : -. Générée par votre logiciel, unique pour chaque nouvelle opération et conservée pour ses nouvelles tentatives pendant sept jours. Voir comment éviter les doublons.16-128 characters: ASCII letters, digits and . _ : -. Generated by your software, unique for each new operation and retained for retries during seven days. See how to prevent duplicates. |
| ChampField | Type / obligationType / requirement | DescriptionDescription |
|---|---|---|
| metadata | JSON · requisrequired | Informations du dépôt, décrites ci-dessous.Submission information, described below. |
| primary_document | Fichier · requisFile · required | CV par défaut, ou diplôme si document_type=diploma est autorisé.CV by default, or diploma if document_type=diploma is allowed. |
| attachment_N | Fichier · conditionnelFile · conditional | Pièce supplémentaire déclarée dans metadata.documents. Utilisez une partie par fichier.Additional attachment declared in metadata.documents; one part per file. |
Les exemples cURL utilisent un fichier metadata.json. Dans votre logiciel, vous pouvez construire le JSON directement, sans créer ce fichier.JSON can be built in memory. The cURL examples read it from metadata.json; this intermediate file is optional in your integration.
Champs du bloc metadatametadata fields
| ChampField | Type / obligationType / requirement | DescriptionDescription |
|---|---|---|
submitter_id | integer · facultatifoptional | Déposant autorisé. Omettre pour le compte par défaut. Voir les déposants autorisés.Permitted submitter. Omit for the default account. View permitted submitters. |
document_type | string · facultatifoptional cv / diploma | Utilisez cv pour un CV. Le mode diploma doit être activé et nécessite un email et un téléphone. Voir les règles du document principal.Defaults to cv; diploma requires enablement, candidate email and phone. View primary document rules. |
profile_id | integer · selon configurationdepends on configuration | Obligatoire si profile_required=true. Utilisez l’identifiant renvoyé par le catalogue. Voir les profils disponibles.Required if profile_required=true; use a catalogue id. View available profiles. |
candidate | object · selon configurationdepends on configuration | Informations connues sur le candidat. Les données fournies sont préservées lors de l’extraction. Voir les champs candidat.Known candidate information. Supplied fields are preserved during extraction. View candidate fields. |
comment | string · facultatifoptional Longueur max. : Max length: 10000 | Commentaire de dépôt, limité à 10 000 octets UTF-8.Submission comment, limited to 10,000 UTF-8 bytes. |
documents | object[] · selon configurationdepends on configuration Éléments max. : Max items: 20 | Pièces supplémentaires, maximum 20. Chaque entrée correspond à une partie multipart attachment_N. Voir comment joindre des pièces.Up to 50 extra files. Each entry matches a multipart attachment_N part. See how to attach documents. |
confidential | boolean · facultatifoptional | Si true, le dossier est réservé au déposant dans l’espace client et via l’API, même dans un groupe partagé ou parent. Vérifiez que can_deposit_confidential vaut true pour ce compte dans GET /v1/submitters. Par défaut : false. Vérifier le droit de dépôt confidentiel.If true, the case is private to its submitter in the client application and API, including shared and parent groups. Check that can_deposit_confidential is true for this account in GET /v1/submitters. Defaults to false. Check confidential deposit permission. |
Contenu de metadatametadata content
{
"profile_id": 42,
"candidate": {
"first_name": "Alice",
"last_name": "Exemple",
"email": "alice@example.invalid",
"phone": "+33600000000"
}
}Exemple de requêteRequest example
curl --fail-with-body --request POST "https://api.verifcv.com/v1/cases" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
--form 'metadata=@metadata.json;type=application/json' \
--form 'primary_document=@cv.pdf;type=application/pdf'<?php
$ACCESS_TOKEN = getenv('ACCESS_TOKEN');
$IDEMPOTENCY_KEY = getenv('IDEMPOTENCY_KEY');
$ch = curl_init('https://api.verifcv.com/v1/cases');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $ACCESS_TOKEN,
'Idempotency-Key: ' . $IDEMPOTENCY_KEY,
],
CURLOPT_POSTFIELDS => [
'metadata' => '{"profile_id": 42, "candidate": {"first_name": "Alice", "last_name": "Exemple", "email": "alice@example.invalid", "phone": "+33600000000"}}',
'primary_document' => new CURLFile(__DIR__ . '/cv.pdf', 'application/pdf', 'cv.pdf'),
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
echo $response;Le contenu des fichiers est représenté ici par un texte indicatif. Votre bibliothèque HTTP transmet les fichiers et génère le séparateur multipart (boundary).File contents are represented here by placeholder text. Your HTTP library sends the files and generates the multipart boundary.
POST https://api.verifcv.com/v1/cases HTTP/1.1
Host: api.verifcv.com
Authorization: Bearer <ACCESS_TOKEN>
Idempotency-Key: <IDEMPOTENCY_KEY>
Content-Type: multipart/form-data; boundary=VerifCVExampleBoundary
--VerifCVExampleBoundary
Content-Disposition: form-data; name="metadata"
Content-Type: application/json
{
"profile_id": 42,
"candidate": {
"first_name": "Alice",
"last_name": "Exemple",
"email": "alice@example.invalid",
"phone": "+33600000000"
}
}
--VerifCVExampleBoundary
Content-Disposition: form-data; name="primary_document"; filename="cv.pdf"
Content-Type: application/pdf
<binary bytes: cv.pdf>
--VerifCVExampleBoundary--Exemples de réponseResponse examples
{
"reference": "VCV-0123456789abcdef0123456789abcdef",
"submitter_id": 12,
"status": {
"code": "in_progress",
"label": "En cours"
},
"created_at": 1792922400
}{
"error": {
"code": "validation_failed",
"message": "profile_id is required.",
"details": [
{
"field": "profile_id",
"code": "required"
}
],
"request_id": "req_6661278af7d288c6f06efb9af9a893aa"
}
}Consulter la référence des identifiants : profil, point du catalogue, vérification du dossier et document.See the identifier reference: profile, catalogue slot, case verification and document.
Structure complète de la réponse et codes HTTPFull response structure and HTTP codes
| ChampField | TypeType | Toujours présentAlways present | DescriptionDescription |
|---|---|---|---|
reference | string | OuiYes | Référence du dossier. À utiliser pour le consulter ou le compléter.Case reference. Use it to read or update the case. |
submitter_id | integer | OuiYes | Identifiant du compte déposant.Submitting account ID. |
status | object | OuiYes | Statut visible dans l’application client.Status shown in the client application. |
status. | string | OuiYes | Code du statut indépendant de la langue. D’autres codes peuvent être renvoyés. Pour une vérification, unmapped désigne un état métier pas encore associé à un code API explicite.Language-independent status code. Additional codes may be returned. For checks, unmapped identifies a business state not yet assigned an explicit API code. Voir les codes des dossiers.View case status codes. |
status. | string | OuiYes | Libellé du statut affiché au client. Sa langue dépend de Accept-Language lorsque la traduction existe.Client-facing status label. Its language follows Accept-Language when a translation exists. |
status. | string | NonNo | Couleur affichée dans l’application client. Un même code de statut peut avoir plusieurs couleurs selon le contexte. Utilisez la valeur renvoyée. Pour un dossier, elle tient compte des vérifications et des règles du client.Color shown in the client application. The same status code may have different colors depending on context. Use the returned value. For a case, it reflects its checks and client-specific rules. |
created_at | integer | OuiYes | Date de création, en secondes Unix UTC.Creation time in Unix UTC seconds. |
| HTTP | SignificationMeaning |
|---|---|
| 201 | Création réussie.Success |
| 400 | Requête invalide. Consultez le message d’erreur.Request rejected |
| 401 | Jeton absent, invalide ou expiré.Missing or invalid token |
| 403 | Cet accès ne permet pas cette opération.Operation not allowed |
| 404 | Ressource introuvable ou inaccessible à ce compte.Resource absent or outside account scope |
| 409 | La requête entre en conflit avec une opération ou un état existant.Request rejected |
| 413 | Le contenu envoyé dépasse la taille autorisée.Request rejected |
| 415 | Le format envoyé n’est pas accepté.Request rejected |
| 422 | Une ou plusieurs données sont invalides. Consultez les détails de l’erreur.Request rejected |
| 429 | Trop de requêtes. Retry-After indique le délai d’attente en secondes.Rate limit reached. Retry-After is in seconds |
| 503 | Service temporairement indisponible.Temporarily unavailable. no partial creation |
Informations candidatCandidate information
Transmettez les informations connues dans metadata.candidate. L’extraction du CV complète les champs absents et conserve les valeurs fournies. Seuls les champs ci-dessous sont acceptés.Send known information in metadata.candidate. CV extraction fills missing fields and preserves supplied values. Only the fields below are accepted.
En mode CV, vérifiez required_candidate_fields dans le profil choisi ou dans default_configuration, renvoyés par GET /v1/profiles. Cette liste indique les champs à fournir obligatoirement. En mode diplôme, l’email et le téléphone sont toujours obligatoires.In CV mode, check required_candidate_fields in the chosen profile or default_configuration returned by GET /v1/profiles. This list identifies the fields you must provide. In diploma mode, email and phone are always required.
Les limites sont indiquées pour chaque champ, en caractères, et s’appliquent dès que vous le renseignez. Les espaces en début et fin sont retirés avant validation. Une valeur trop longue est refusée avec une erreur 422, sans être tronquée.Limits are shown for each field, in characters. Leading and trailing whitespace is removed before validation. Values exceeding the limit are rejected with HTTP 422, not truncated.
| ChampField | Type / obligationType / requirement | DescriptionDescription |
|---|---|---|
first_name | string · facultatifoptional Longueur max. : Max length: 200 | Prénom.First name. |
last_name | string · facultatifoptional Longueur max. : Max length: 200 | Nom.Last name. |
birth_name | string · facultatifoptional Longueur max. : Max length: 200 | Nom de naissance.Birth name. |
email | string · requis dans certains casrequired in some cases Longueur max. : Max length: 200 · email | Email valide. Obligatoire si email figure dans required_candidate_fields, ou si document_type vaut diploma.Valid email. Required if email appears in required_candidate_fields, or if document_type is diploma. |
phone | string · requis dans certains casrequired in some cases | Téléphone renseigné : au moins 6 chiffres, 40 caractères maximum hors + initial facultatif. Espaces, parenthèses, tirets et points acceptés. Obligatoire si phone figure dans required_candidate_fields, ou si document_type vaut diploma.When provided: at least 6 digits, at most 40 characters excluding an optional leading +. Spaces, parentheses, hyphens and dots are allowed. Required if phone appears in required_candidate_fields, or if document_type is diploma. |
street_number | string · facultatifoptional Longueur max. : Max length: 100 | Numéro de voie.Street number. |
street | string · facultatifoptional Longueur max. : Max length: 100 | Voie.Street. |
postal_code | string · facultatifoptional Longueur max. : Max length: 100 | Code postal sous forme de texte.Postal code as text. |
city | string · facultatifoptional Longueur max. : Max length: 100 | Ville.City. |
country | string · facultatifoptional Longueur max. : Max length: 100 | Pays, sous forme de texte.Country as text. |
birth_date | date · facultatifoptional YYYY-MM-DD | Date valide au format YYYY-MM-DD.Valid date in YYYY-MM-DD format. |
hiring_date | date · requis dans certains casrequired in some cases YYYY-MM-DD | Date d’embauche au format YYYY-MM-DD. Obligatoire si hiring_date figure dans required_candidate_fields. Cette obligation peut être héritée d’un groupe parent.Hiring date in YYYY-MM-DD format. Required if hiring_date appears in required_candidate_fields. This requirement may be inherited from a parent group. |
Joindre les bonnes pièces au dépôtAttach the correct files at creation
Déclarez chaque pièce dans metadata.documents. part doit correspondre au nom de la partie multipart. Le champ point_id désigne le point autorisé du catalogue. Deux points du même type, par exemple deux diplômes, ont des point_id distincts.Declare each attachment in metadata.documents. part must match the multipart part name; point_id identifies the permitted catalogue slot. Two checks of the same type, such as two diplomas, have distinct point_id values.
| ChampField | Type / obligationType / requirement | DescriptionDescription |
|---|---|---|
part | string · requisrequired | Nom exact de la partie multipart, par exemple attachment_1.Exact multipart part name, e.g. attachment_1. |
kind | string · facultatifoptional point / general | Utilisez point pour une pièce liée à une vérification. Pour utiliser general, vérifiez que general_documents_allowed vaut true dans GET /v1/profiles.Defaults to point. For general, check that general_documents_allowed is true in GET /v1/profiles. |
point_id | integer · selon configurationdepends on configuration | Obligatoire pour kind=point : id du catalogue, jamais id d’une vérification déjà créée. Interdit pour general. Comprendre les identifiants.Required for kind=point: catalogue ID, not a created check ID. Forbidden for general. Understand identifiers. |
{
"profile_id": 42,
"candidate": {
"first_name": "Alice",
"last_name": "Exemple",
"email": "alice@example.invalid",
"phone": "+33600000000"
},
"documents": [
{
"part": "attachment_1",
"point_id": 6
},
{
"part": "attachment_2",
"point_id": 5
},
{
"part": "attachment_3",
"kind": "general"
}
]
}curl --fail-with-body --request POST "https://api.verifcv.com/v1/cases" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
--form 'metadata=@metadata.json;type=application/json' \
--form 'primary_document=@cv.pdf;type=application/pdf' \
--form 'attachment_1=@diplome.pdf;type=application/pdf' \
--form 'attachment_2=@identite.pdf;type=application/pdf' \
--form 'attachment_3=@document-complementaire.pdf;type=application/pdf'<?php
$ACCESS_TOKEN = getenv('ACCESS_TOKEN');
$IDEMPOTENCY_KEY = getenv('IDEMPOTENCY_KEY');
$ch = curl_init('https://api.verifcv.com/v1/cases');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $ACCESS_TOKEN,
'Idempotency-Key: ' . $IDEMPOTENCY_KEY,
],
CURLOPT_POSTFIELDS => [
'metadata' => '{"profile_id": 42, "candidate": {"first_name": "Alice", "last_name": "Exemple", "email": "alice@example.invalid", "phone": "+33600000000"}, "documents": [{"part": "attachment_1", "point_id": 6}, {"part": "attachment_2", "point_id": 5}, {"part": "attachment_3", "kind": "general"}]}',
'primary_document' => new CURLFile(__DIR__ . '/cv.pdf', 'application/pdf', 'cv.pdf'),
'attachment_1' => new CURLFile(__DIR__ . '/diplome.pdf', 'application/pdf', 'diplome.pdf'),
'attachment_2' => new CURLFile(__DIR__ . '/identite.pdf', 'application/pdf', 'identite.pdf'),
'attachment_3' => new CURLFile(__DIR__ . '/document-complementaire.pdf', 'application/pdf', 'document-complementaire.pdf'),
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
echo $response;Le contenu des fichiers est représenté ici par un texte indicatif. Votre bibliothèque HTTP transmet les fichiers et génère le séparateur multipart (boundary).File contents are represented here by placeholder text. Your HTTP library sends the files and generates the multipart boundary.
POST https://api.verifcv.com/v1/cases HTTP/1.1
Host: api.verifcv.com
Authorization: Bearer <ACCESS_TOKEN>
Idempotency-Key: <IDEMPOTENCY_KEY>
Content-Type: multipart/form-data; boundary=VerifCVExampleBoundary
--VerifCVExampleBoundary
Content-Disposition: form-data; name="metadata"
Content-Type: application/json
{
"profile_id": 42,
"candidate": {
"first_name": "Alice",
"last_name": "Exemple",
"email": "alice@example.invalid",
"phone": "+33600000000"
},
"documents": [
{
"part": "attachment_1",
"point_id": 6
},
{
"part": "attachment_2",
"point_id": 5
},
{
"part": "attachment_3",
"kind": "general"
}
]
}
--VerifCVExampleBoundary
Content-Disposition: form-data; name="primary_document"; filename="cv.pdf"
Content-Type: application/pdf
<binary bytes: cv.pdf>
--VerifCVExampleBoundary
Content-Disposition: form-data; name="attachment_1"; filename="diplome.pdf"
Content-Type: application/pdf
<binary bytes: diplome.pdf>
--VerifCVExampleBoundary
Content-Disposition: form-data; name="attachment_2"; filename="identite.pdf"
Content-Type: application/pdf
<binary bytes: identite.pdf>
--VerifCVExampleBoundary
Content-Disposition: form-data; name="attachment_3"; filename="document-complementaire.pdf"
Content-Type: application/pdf
<binary bytes: document-complementaire.pdf>
--VerifCVExampleBoundary--Dans cet exemple, attachment_1 est la copie du diplôme et attachment_2 la pièce d’identité. attachment_3 est un document complémentaire du dossier, classé dans les pièces générales. Il utilise kind: general sans point_id.In this example, attachment_1 is the diploma copy and attachment_2 is the identity document. attachment_3 is a supplementary case document stored with general attachments. It uses kind: general without point_id.
Vérifiez document_allowed et accepted_extensions pour chaque point. Si general_documents_allowed vaut true dans GET /v1/profiles, utilisez {"part":"attachment_1","kind":"general"} sans point_id.Check document_allowed and accepted_extensions for each check. If general_documents_allowed is true in GET /v1/profiles, use {"part":"attachment_1","kind":"general"} without point_id.
Cette autorisation concerne uniquement les documents généraux. Les pièces liées à une vérification restent autorisées lorsque document_allowed vaut true pour ce point.This permission only applies to general documents. Documents linked to a check remain allowed when document_allowed is true for that check.
Déposer un diplôme à la place du CVSubmit a diploma instead of a CV
{
"profile_id": 42,
"candidate": {
"first_name": "Alice",
"last_name": "Exemple",
"email": "alice@example.invalid",
"phone": "+33600000000"
},
"document_type": "diploma"
}Pour déposer un diplôme comme document principal, utilisez document_type=diploma et joignez le diplôme dans primary_document. Ce mode doit être autorisé pour votre intégration et votre groupe. L’email et le téléphone du candidat sont obligatoires. Les exigences du profil restent applicables.To submit a diploma as the primary document, set document_type=diploma and attach the diploma in primary_document. This mode must be enabled for your integration and group. Candidate email and phone are required; profile requirements still apply.
Formats et limitesFormats and limits
| ÉlémentItem | RègleRule |
|---|---|
| Document principal CVMain CV | PDF, DOC, DOCX, ODT, RTF, TXT, JPEG, PNG, GIF |
| Pièces de vérificationCheck attachments | PDF, DOC, DOCX, ODT, RTF, TXT, JPEG, PNG, GIF - selon accepted_extensions du point.subject to the check’s accepted_extensions. |
| Limites de dépôtSubmission limits | 10 Mio par fichier, 50 Mio par requête et 20 pièces supplémentaires au maximum.10 MiB per file. 50 MiB per request. Up to 20 additional files. |
Contrôle antivirus des documentsDocument antivirus scanning
Chaque fichier est analysé avant la création du dossier. Les fichiers détectés comme malveillants, contenant des macros ou chiffrés sont refusés. Si l’analyse est indisponible, aucun dossier n’est créé et le dépôt peut être réessayé plus tard.Each file is scanned before the case is created. Files detected as malicious, containing macros or encrypted are rejected. If scanning is unavailable, no case is created and the submission can be retried later.
Relancer sans créer de doublonRetry without creating duplicates
Idempotency-Key est requis pour créer un dossier ou ajouter une pièce. Générez une clé pour chaque nouvelle opération et conservez-la avec le contenu envoyé. Réutilisez cette clé pour les nouvelles tentatives de la même opération.Idempotency-Key is required to create a case or add a document. Generate one key per new operation and store it with the submitted content. Reuse it when retrying that operation.
Format : 16 à 128 caractères ASCII parmi les lettres, chiffres et . _ : -. Un UUID convient, par exemple 1a4195a1-164c-47d7-8022-c2118f737ad2. Votre logiciel génère sa propre clé, sans appel préalable à l’API.Format: 16-128 ASCII characters using letters, digits and . _ : -. A UUID is suitable, for example 1a4195a1-164c-47d7-8022-c2118f737ad2. Your software generates its own key without a prior API call.
| SituationSituation | ComportementBehaviour |
|---|---|
| Même clé, même contenuSame key, same content | L’API renvoie la réponse initiale sans créer de doublon.Original response replayed, no new submission. |
| Même clé, contenu différentSame key, different content | 409 · idempotency_conflict |
| Nouvelle opérationNew operation | Nouvelle clé, par exemple un UUID.New key, for example a UUID. |
| DuréeRetention | 7 jours, par intégration et opération. Après expiration, vérifiez si le dépôt a abouti avant de le renvoyer.7 days per integration and operation. After expiry, check whether submission succeeded before resending it. |
| SituationSituation | Que faire ?What to do | Clé d’idempotenceIdempotency key |
|---|---|---|
| Coupure réseauNetwork interruption | Renvoyer la même demande avec les mêmes fichiers.Resend the same request with the same files. | Même cléSame key |
| Données invalides (422)Invalid data (422) | Corriger les champs signalés.Correct the reported fields. | Nouvelle cléNew key |
| Trop de requêtes (429)Too many requests (429) | Attendre le délai Retry-After, en secondes, puis renvoyer la même demande.Wait for the Retry-After delay in seconds, then resend the same request. | Même cléSame key |
| Service indisponible (503)Service unavailable (503) | Attendre avant de renvoyer la même demande.Wait before resending the same request. | Même cléSame key |
Lister et synchroniser les dossiersList and synchronize cases
/v1/casesRetourne une synthèse des dossiers actuellement accessibles. Pour récupérer toutes les pages, appelez l’adresse pagination.next jusqu’à ce qu’elle vaille null. updated_since est inclusif et prend en compte les modifications visibles des points, documents, résultats et historiques.Returns summaries of currently accessible cases. To retrieve every page, call the pagination.next address until it is null. updated_since is inclusive and covers visible changes to checks, documents, results and history.
| ChampField | Type / obligationType / requirement | DescriptionDescription |
|---|---|---|
limit | query · integer · facultatifoptional | Taille de page : défaut 50, minimum 1, maximum 100.Page size: default 50, minimum 1, maximum 100. |
offset | query · integer · facultatifoptional | Décalage à partir de 0. Utilisez next pour les pages suivantes.Offset starting at 0; use next for subsequent pages. |
updated_since | query · integer · facultatifoptional | Sélectionne les dossiers modifiés depuis cette date, incluse, en secondes Unix UTC. À utiliser pour démarrer une nouvelle synchronisation sans snapshot. Inutile de le répéter pour parcourir le snapshot reçu. Voir les règles de synchronisation.Selects cases changed on or after this UTC Unix timestamp in seconds. Use it to start a new synchronization without a snapshot. It need not be repeated when paging through the returned snapshot. View synchronization rules. |
snapshot | query · string · facultatifoptional | À omettre au premier appel. Inclus automatiquement dans pagination.next pour les pages suivantes. Conserve la même sélection lorsque l’offset change. La sélection tient déjà compte du filtre updated_since initial. Ne le répétez pas. Valable 30 minutes. Voir les règles de pagination.Omit on the first call. Automatically included in pagination.next for subsequent pages. Preserves the same selection when the offset changes. The selection already incorporates the initial updated_since filter. Do not repeat it. Valid for 30 minutes. View pagination rules. |
Accept-Language | header · string · facultatifoptional | fr (défaut) ou en pour les libellés de restitution. Les codes restent stables.fr (default) or en for response labels. Codes remain stable. |
Pour parcourir les pages, suivez pagination.next ou réutilisez le même snapshot en augmentant offset. Le snapshot conserve la sélection initiale et évite que de nouveaux dossiers décalent les pages. Voir les exemples de pagination et de synchronisation.To browse pages, follow pagination.next or reuse the same snapshot while increasing offset. The snapshot preserves the initial selection and prevents new cases from shifting pages. See pagination and synchronization examples.
Exemple de requêteRequest example
curl --fail-with-body --request GET "https://api.verifcv.com/v1/cases?limit=50&offset=0" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Accept: application/json"<?php
$ACCESS_TOKEN = getenv('ACCESS_TOKEN');
$ch = curl_init('https://api.verifcv.com/v1/cases?limit=50&offset=0');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $ACCESS_TOKEN,
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
echo $response;GET https://api.verifcv.com/v1/cases?limit=50&offset=0 HTTP/1.1
Host: api.verifcv.com
Authorization: Bearer <ACCESS_TOKEN>
Accept: application/jsonPour demander les libellés anglais, ajoutez l’en-tête Accept-Language: en. Les codes restent identiques.To request English labels, add the Accept-Language: en header. Codes stay unchanged.
Exemples de réponseResponse examples
{
"data": [
{
"reference": "VCV-0123456789abcdef0123456789abcdef",
"submitter_id": 12,
"status": {
"code": "in_progress",
"label": "En cours",
"color": "#d2d6de"
},
"created_at": 1792922400,
"profile_id": 42,
"candidate": {
"first_name": "Alice",
"last_name": "Exemple",
"email": "alice@example.invalid"
},
"progress": 0,
"updated_at": 1792922400
}
],
"pagination": {
"limit": 50,
"offset": 0,
"total": 1,
"next": null,
"snapshot": "a38b3e63b12a7804e579bfe3f90b7a08694730a692a394fa4a6d65532b92a747",
"snapshot_expires_at": 1792924200
}
}Exemple avec limit=1 et deux dossiers au total. Le premier dossier est renvoyé ici. Appelez l’adresse next pour récupérer le second. Le snapshot est déjà inclus dans cette adresse.Example with limit=1 and two cases in total. The first case is returned here. Call the next address to retrieve the second case. The snapshot is already included in that address.
{
"data": [
{
"reference": "VCV-0123456789abcdef0123456789abcdef",
"submitter_id": 12,
"status": {
"code": "in_progress",
"label": "En cours",
"color": "#d2d6de"
},
"created_at": 1792922400,
"profile_id": 42,
"candidate": {
"first_name": "Alice",
"last_name": "Exemple",
"email": "alice@example.invalid"
},
"progress": 0,
"updated_at": 1792922400
}
],
"pagination": {
"limit": 1,
"offset": 0,
"total": 2,
"next": "/v1/cases?limit=1&offset=1&snapshot=a38b3e63b12a7804e579bfe3f90b7a08694730a692a394fa4a6d65532b92a747",
"snapshot": "a38b3e63b12a7804e579bfe3f90b7a08694730a692a394fa4a6d65532b92a747",
"snapshot_expires_at": 1792924200
}
}{
"error": {
"code": "snapshot_expired",
"message": "Restart listing from offset zero.",
"details": [],
"request_id": "req_8085286fac1307159ef9e1848ce2224b"
}
}Structure complète de la réponse et codes HTTPFull response structure and HTTP codes
| ChampField | TypeType | Toujours présentAlways present | DescriptionDescription |
|---|---|---|---|
data | object[] | OuiYes | Dossiers de la page courante.Cases on the current page. |
data[]. | string | OuiYes | Référence du dossier. À utiliser pour le consulter ou le compléter.Case reference. Use it to read or update the case. |
data[]. | integer | OuiYes | Identifiant du compte déposant.Submitting account ID. |
data[]. | integer / null | OuiYes | Identifiant du profil appliqué. Vaut null si le dossier utilise la configuration de base.Applied profile ID. Null when the case uses the base configuration. |
data[]. | object | OuiYes | Informations du candidat.Candidate information. |
data[]. | string | NonNo | Prénom du candidat.Candidate’s first name. |
data[]. | string | NonNo | Nom du candidat.Candidate’s last name. |
data[]. | string | NonNo | Nom de naissance du candidat.Candidate’s birth name. |
data[]. | string | NonNo | Adresse email du candidat.Candidate’s email address. |
data[]. | string | NonNo | Numéro de téléphone du candidat.Candidate’s phone number. |
data[]. | string | NonNo | Numéro dans la rue.Street number. |
data[]. | string | NonNo | Nom de la rue.Street name. |
data[]. | string | NonNo | Code postal.Postal code. |
data[]. | string | NonNo | Ville.City. |
data[]. | string | NonNo | Pays.Country. |
data[]. | string | NonNo | Date de naissance au format YYYY-MM-DD.Birth date in YYYY-MM-DD format. |
data[]. | string | NonNo | Date d’embauche au format YYYY-MM-DD. Obligatoire si hiring_date figure dans required_candidate_fields. Cette obligation peut être héritée d’un groupe parent.Hiring date in YYYY-MM-DD format. Required when hiring_date appears in required_candidate_fields. This requirement may be inherited from a parent group. |
data[]. | object | OuiYes | Statut visible dans l’application client.Status shown in the client application. |
data[]. | string | OuiYes | Code du statut indépendant de la langue. D’autres codes peuvent être renvoyés. Pour une vérification, unmapped désigne un état métier pas encore associé à un code API explicite.Language-independent status code. Additional codes may be returned. For checks, unmapped identifies a business state not yet assigned an explicit API code. Voir les codes des dossiers.View case status codes. |
data[]. | string | OuiYes | Libellé du statut affiché au client. Sa langue dépend de Accept-Language lorsque la traduction existe.Client-facing status label. Its language follows Accept-Language when a translation exists. |
data[]. | string | NonNo | Couleur affichée dans l’application client. Un même code de statut peut avoir plusieurs couleurs selon le contexte. Utilisez la valeur renvoyée. Pour un dossier, elle tient compte des vérifications et des règles du client.Color shown in the client application. The same status code may have different colors depending on context. Use the returned value. For a case, it reflects its checks and client-specific rules. |
data[]. | integer | OuiYes | Avancement du dossier, de 0 à 100 %.Case progress, from 0 to 100%. |
data[]. | integer | OuiYes | Date de création, en secondes Unix UTC.Creation time in Unix UTC seconds. |
data[]. | integer | OuiYes | Date de dernière modification visible, en secondes Unix UTC.Last visible update time in Unix UTC seconds. |
pagination | object | OuiYes | Informations pour parcourir les pages de résultats.Information for browsing result pages. |
pagination. | integer | OuiYes | Nombre maximal d’éléments par page.Maximum number of items per page. |
pagination. | integer | OuiYes | Nombre d’éléments ignorés avant cette page. La première page commence à 0.Number of items skipped before this page. The first page starts at 0. |
pagination. | integer | OuiYes | Nombre total d’éléments correspondant à la recherche.Total number of matching items. |
pagination. | string / null | OuiYes | Adresse de la page suivante. Vaut null lorsqu’il n’y a plus de page.Next page address. Null when there are no more pages. |
pagination. | string / null | NonNo | Identifiant de la sélection figée des dossiers. À conserver pour parcourir ses pages.Identifier of the frozen case selection. Keep it when browsing its pages. |
pagination. | integer / null | NonNo | Date d’expiration du snapshot, en secondes Unix UTC.Snapshot expiry time in Unix UTC seconds. |
| HTTP | SignificationMeaning |
|---|---|
| 200 | Requête réussie.Success |
| 400 | Requête invalide. Consultez le message d’erreur.Request rejected |
| 401 | Jeton absent, invalide ou expiré.Missing or invalid token |
| 403 | Cet accès ne permet pas cette opération.Operation not allowed |
| 404 | Ressource introuvable ou inaccessible à ce compte.Resource absent or outside account scope |
| 409 | La requête entre en conflit avec une opération ou un état existant.Request rejected |
| 413 | Le contenu envoyé dépasse la taille autorisée.Request rejected |
| 415 | Le format envoyé n’est pas accepté.Request rejected |
| 422 | Une ou plusieurs données sont invalides. Consultez les détails de l’erreur.Request rejected |
| 429 | Trop de requêtes. Retry-After indique le délai d’attente en secondes.Rate limit reached. Retry-After is in seconds |
| 503 | Service temporairement indisponible.Temporarily unavailable. no partial creation |
Pagination et synchronisationPagination and synchronization
| UsageUsage | RègleRule |
|---|---|
| PaginationPagination | Suivez pagination.next jusqu’à null, ou réutilisez le snapshot du premier appel, qui conserve la même sélection de dossiers, en augmentant offset de limit à chaque page.Follow pagination.next until null, or reuse the first response’s snapshot, which preserves the same selection of cases, increasing offset by limit for each page. |
| SynchronisationSynchronization | Démarrez chaque nouveau cycle avec updated_since et sans snapshot. Après traitement réussi de toutes les pages, conservez l’heure de début du cycle pour la prochaine synchronisation.Start each new cycle with updated_since and no snapshot. After successfully processing all pages, retain the cycle start time for the next synchronization. |
curl --fail-with-body --request GET "https://api.verifcv.com/v1/cases?limit=50&offset=0&updated_since=1792922400" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Accept: application/json"<?php
$ACCESS_TOKEN = getenv('ACCESS_TOKEN');
$ch = curl_init('https://api.verifcv.com/v1/cases?limit=50&offset=0&updated_since=1792922400');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $ACCESS_TOKEN,
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
echo $response;GET https://api.verifcv.com/v1/cases?limit=50&offset=0&updated_since=1792922400 HTTP/1.1
Host: api.verifcv.com
Authorization: Bearer <ACCESS_TOKEN>
Accept: application/jsonGET /v1/cases?updated_since=1792922400&limit=50&offset=0
GET /v1/cases?snapshot=<SNAPSHOT>&limit=50&offset=50
GET /v1/cases?snapshot=<SNAPSHOT>&limit=50&offset=100SNAPSHOT est la valeur pagination.snapshot reçue au premier appel. Si vous envoyez aussi updated_since avec ce snapshot, sa valeur doit rester identique au premier appel.SNAPSHOT is pagination.snapshot from the first response. If you also send updated_since with that snapshot, it must match the original value.
Durée et fonctionnement du snapshotSnapshot lifetime and behaviour
Si l’API renvoie snapshot_expired, recommencez le parcours avec la même valeur updated_since.If the API returns snapshot_expired, restart pagination with the same updated_since value.
Une sélection dure 30 minutes et fige les identifiants, pas les résultats. Chaque page vérifie les droits actuels : elle peut contenir moins de lignes que limit. Suivez next même si data est vide. Le total correspond aux emplacements de la sélection initiale. Aucun webhook n’est envoyé : votre logiciel décide de la fréquence de consultation.A selection lasts 30 minutes and freezes identifiers, not results. Each page checks current permissions and may return fewer than limit rows. Follow next even when data is empty. total counts slots in the initial selection. No webhooks are sent: your software chooses the polling frequency.
Lire les résultats d’un dossierRead case results
/v1/cases/{reference}Retourne le candidat, le statut global, l’avancement de 0 à 100 et tous les points visibles côté client. Utilisez status.code pour la logique de votre logiciel, status.label pour l’affichage. La réception d’un fichier ne valide jamais automatiquement un point.Returns candidate data, overall status, progress from 0 to 100 and all client-visible checks. Use status.code for application logic and status.label for display. Receiving a file never automatically validates a check.
| ChampField | Type / obligationType / requirement | DescriptionDescription |
|---|---|---|
reference | path · string · requisrequired | Référence dossier générée par VerifCV et renvoyée à la création.Case reference generated by VerifCV and returned on creation. |
Accept-Language | header · string · facultatifoptional | fr (défaut) ou en pour les libellés de restitution. Les codes restent stables.fr (default) or en for response labels. Codes remain stable. |
Exemple de requêteRequest example
curl --fail-with-body --request GET "https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Accept: application/json"<?php
$ACCESS_TOKEN = getenv('ACCESS_TOKEN');
$ch = curl_init('https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $ACCESS_TOKEN,
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
echo $response;GET https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef HTTP/1.1
Host: api.verifcv.com
Authorization: Bearer <ACCESS_TOKEN>
Accept: application/jsonPour demander les libellés anglais, ajoutez l’en-tête Accept-Language: en. Les codes restent identiques.To request English labels, add the Accept-Language: en header. Codes stay unchanged.
Exemples de réponseResponse examples
{
"reference": "VCV-0123456789abcdef0123456789abcdef",
"submitter_id": 12,
"status": {
"code": "in_progress",
"label": "En cours",
"color": "#d2d6de"
},
"created_at": 1792922400,
"profile_id": 42,
"candidate": {
"first_name": "Alice",
"last_name": "Exemple",
"email": "alice@example.invalid"
},
"progress": 0,
"updated_at": 1792922400,
"verifications": [
{
"id": "800",
"id_type": 1,
"label": "Auto",
"status": {
"code": "in_progress",
"label": "En cours",
"color": "#d2d6de"
},
"derogated": false,
"details": [],
"comment": null,
"documents": [],
"can_upload_document": true
},
{
"id": "801",
"id_type": 3,
"label": "Diplôme",
"status": {
"code": "in_progress",
"label": "En cours",
"color": "#d2d6de"
},
"derogated": false,
"details": [
{
"code": "institution",
"label": "Établissement",
"value": "Université Exemple"
},
{
"code": "qualification",
"label": "Formation",
"value": "Master en informatique"
},
{
"code": "graduation_year",
"label": "Promotion",
"value": "2022"
}
],
"comment": null,
"documents": [
{
"id": "6328fb86d4db5063ee0d70148151babc162433b0c525e39304064f8474f7a676",
"name": "diplome.pdf",
"content_type": "application/pdf",
"size": 24576,
"verification_id": 801,
"download_url": "/v1/cases/VCV-0123456789abcdef0123456789abcdef/documents/6328fb86d4db5063ee0d70148151babc162433b0c525e39304064f8474f7a676"
}
],
"can_upload_document": false
},
{
"id": "802",
"id_type": 4,
"label": "Référence",
"status": {
"code": "in_progress",
"label": "En cours",
"color": "#d2d6de"
},
"derogated": false,
"details": [
{
"code": "employer",
"label": "Entreprise",
"value": "Société Exemple"
},
{
"code": "job_title",
"label": "Poste",
"value": "Développeuse informatique"
},
{
"code": "start_date",
"label": "Date de début",
"value": "2022-09-01"
},
{
"code": "end_date",
"label": "Date de fin",
"value": "2025-08-31"
},
{
"code": "contract_type",
"label": "Type de contrat",
"value": "CDI"
},
{
"code": "departure",
"label": "Départ",
"value": null
},
{
"code": "departure_reason",
"label": "Raison du départ",
"value": null
}
],
"comment": null,
"documents": [],
"can_upload_document": true
}
],
"report": {
"available": false,
"kind": null,
"download_url": null
},
"documents": [
{
"id": "0925a10ed22a82d717c814811f237731ab74209577b55e4cd50cd44c04d89ca6",
"name": "cv.pdf",
"content_type": "application/pdf",
"size": 98304,
"verification_id": null,
"download_url": "/v1/cases/VCV-0123456789abcdef0123456789abcdef/documents/0925a10ed22a82d717c814811f237731ab74209577b55e4cd50cd44c04d89ca6"
},
{
"id": "6328fb86d4db5063ee0d70148151babc162433b0c525e39304064f8474f7a676",
"name": "diplome.pdf",
"content_type": "application/pdf",
"size": 24576,
"verification_id": 801,
"download_url": "/v1/cases/VCV-0123456789abcdef0123456789abcdef/documents/6328fb86d4db5063ee0d70148151babc162433b0c525e39304064f8474f7a676"
}
]
}{
"error": {
"code": "not_found",
"message": "Case not found.",
"details": [],
"request_id": "req_1994c88153211ae6d70c2c35e3183c6a"
}
}Consulter la référence des identifiants : profil, point du catalogue, vérification du dossier et document.See the identifier reference: profile, catalogue slot, case verification and document.
Structure complète de la réponse et codes HTTPFull response structure and HTTP codes
| ChampField | TypeType | Toujours présentAlways present | DescriptionDescription |
|---|---|---|---|
reference | string | OuiYes | Référence du dossier. À utiliser pour le consulter ou le compléter.Case reference. Use it to read or update the case. |
submitter_id | integer | OuiYes | Identifiant du compte déposant.Submitting account ID. |
profile_id | integer / null | OuiYes | Identifiant du profil appliqué. Vaut null si le dossier utilise la configuration de base.Applied profile ID. Null when the case uses the base configuration. |
candidate | object | OuiYes | Informations du candidat.Candidate information. |
candidate. | string | NonNo | Prénom du candidat.Candidate’s first name. |
candidate. | string | NonNo | Nom du candidat.Candidate’s last name. |
candidate. | string | NonNo | Nom de naissance du candidat.Candidate’s birth name. |
candidate. | string | NonNo | Adresse email du candidat.Candidate’s email address. |
candidate. | string | NonNo | Numéro de téléphone du candidat.Candidate’s phone number. |
candidate. | string | NonNo | Numéro dans la rue.Street number. |
candidate. | string | NonNo | Nom de la rue.Street name. |
candidate. | string | NonNo | Code postal.Postal code. |
candidate. | string | NonNo | Ville.City. |
candidate. | string | NonNo | Pays.Country. |
candidate. | string | NonNo | Date de naissance au format YYYY-MM-DD.Birth date in YYYY-MM-DD format. |
candidate. | string | NonNo | Date d’embauche au format YYYY-MM-DD. Obligatoire si hiring_date figure dans required_candidate_fields. Cette obligation peut être héritée d’un groupe parent.Hiring date in YYYY-MM-DD format. Required when hiring_date appears in required_candidate_fields. This requirement may be inherited from a parent group. |
status | object | OuiYes | Statut visible dans l’application client.Status shown in the client application. |
status. | string | OuiYes | Code du statut indépendant de la langue. D’autres codes peuvent être renvoyés. Pour une vérification, unmapped désigne un état métier pas encore associé à un code API explicite.Language-independent status code. Additional codes may be returned. For checks, unmapped identifies a business state not yet assigned an explicit API code. Voir les codes des dossiers.View case status codes. |
status. | string | OuiYes | Libellé du statut affiché au client. Sa langue dépend de Accept-Language lorsque la traduction existe.Client-facing status label. Its language follows Accept-Language when a translation exists. |
status. | string | NonNo | Couleur affichée dans l’application client. Un même code de statut peut avoir plusieurs couleurs selon le contexte. Utilisez la valeur renvoyée. Pour un dossier, elle tient compte des vérifications et des règles du client.Color shown in the client application. The same status code may have different colors depending on context. Use the returned value. For a case, it reflects its checks and client-specific rules. |
progress | integer | OuiYes | Avancement du dossier, de 0 à 100 %.Case progress, from 0 to 100%. |
created_at | integer | OuiYes | Date de création, en secondes Unix UTC.Creation time in Unix UTC seconds. |
updated_at | integer | OuiYes | Date de dernière modification visible, en secondes Unix UTC.Last visible update time in Unix UTC seconds. |
verifications | object[] | OuiYes | Vérifications du dossier, dans l’ordre de l’application client.Case checks in client application order. |
verifications[]. | string | OuiYes | Identifiant de la vérification du dossier.Identifier of the case check. |
verifications[]. | string | OuiYes | Libellé destiné à l’affichage.Display label. |
verifications[]. | object | OuiYes | Statut visible dans l’application client.Status shown in the client application. |
verifications[]. | string | OuiYes | Code du statut indépendant de la langue. D’autres codes peuvent être renvoyés. Pour une vérification, unmapped désigne un état métier pas encore associé à un code API explicite.Language-independent status code. Additional codes may be returned. For checks, unmapped identifies a business state not yet assigned an explicit API code. Voir les codes des vérifications.View verification status codes. |
verifications[]. | string | OuiYes | Libellé du statut affiché au client. Sa langue dépend de Accept-Language lorsque la traduction existe.Client-facing status label. Its language follows Accept-Language when a translation exists. |
verifications[]. | string | NonNo | Couleur affichée dans l’application client. Un même code de statut peut avoir plusieurs couleurs selon le contexte. Utilisez la valeur renvoyée. Pour un dossier, elle tient compte des vérifications et des règles du client.Color shown in the client application. The same status code may have different colors depending on context. Use the returned value. For a case, it reflects its checks and client-specific rules. |
verifications[]. | boolean | OuiYes | Indique si une dérogation est appliquée à cette vérification.Whether this check has a derogation. |
verifications[]. | object[] | OuiYes | Détails du résultat visibles par le client. La liste peut être vide.Result details visible to the client. The list can be empty. |
verifications[]. | string | OuiYes | Code à utiliser pour identifier cette valeur dans votre logiciel.Code used to identify this value in your software. |
verifications[]. | string | OuiYes | Libellé destiné à l’affichage.Display label. |
verifications[]. | string / null | OuiYes | Valeur du détail. Vaut null lorsqu’elle n’est pas renseignée.Detail value. Null when not provided. |
verifications[]. | string / null | NonNo | Commentaire de la vérification visible par le client. Vaut null s’il est absent.Check comment visible to the client. Null when absent. |
verifications[]. | object[] | OuiYes | Documents associés à cette vérification et accessibles à cet accès API.Documents associated with this check and available to this API access. |
verifications[]. | string | OuiYes | Identifiant du document utilisé dans son URL de téléchargement. Il ne révèle pas son chemin de stockage.Document ID used in its download URL. It does not reveal its storage path. |
verifications[]. | string | OuiYes | Nom proposé pour enregistrer le fichier. Votre logiciel peut le renommer.Suggested filename. Your software can rename it. |
verifications[]. | string | OuiYes | Format du fichier, par exemple application/pdf.File media type, for example application/pdf. |
verifications[]. | integer | OuiYes | Taille du fichier en octets.File size in bytes. |
verifications[]. | integer / null | OuiYes | Identifiant de la vérification associée au document. Vaut null si le document est général.ID of the check associated with the document. Null for a general document. |
verifications[]. | string | OuiYes | Adresse de téléchargement à ajouter à la base URL de l’API. Le jeton Bearer reste nécessaire.Download address to append to the API base URL. A Bearer token is still required. Voir comment télécharger le fichier.See how to download the file. |
verifications[]. | boolean | OuiYes | Indique si cet accès peut ajouter un document à cette vérification dans son état actuel.Whether this access can add a document to this check in its current state. |
verifications[]. | integer | OuiYes | Identifiant du type de vérification. Plusieurs points peuvent avoir le même type.Verification type ID. Several checks can share the same type. |
report | object | OuiYes | Disponibilité du rapport et lien de téléchargement.Report availability and download link. |
report. | boolean | OuiYes | Indique si le rapport est disponible au téléchargement.Whether the report is available for download. |
report. | string / null | OuiYes | Type du rapport disponible : final ou interim. Vaut null si aucun rapport n’est disponible.Available report type: final or interim. Null when no report is available. interim / final / None |
report. | string / null | OuiYes | Adresse de téléchargement du rapport à ajouter à la base URL. Vaut null si le rapport est indisponible.Report download address to append to the base URL. Null when unavailable. Voir comment télécharger le fichier.See how to download the file. |
documents | object[] | OuiYes | Documents accessibles avec cet accès API.Documents available to this API access. |
documents[]. | string | OuiYes | Identifiant du document utilisé dans son URL de téléchargement. Il ne révèle pas son chemin de stockage.Document ID used in its download URL. It does not reveal its storage path. |
documents[]. | string | OuiYes | Nom proposé pour enregistrer le fichier. Votre logiciel peut le renommer.Suggested filename. Your software can rename it. |
documents[]. | string | OuiYes | Format du fichier, par exemple application/pdf.File media type, for example application/pdf. |
documents[]. | integer | OuiYes | Taille du fichier en octets.File size in bytes. |
documents[]. | integer / null | OuiYes | Identifiant de la vérification associée au document. Vaut null si le document est général.ID of the check associated with the document. Null for a general document. |
documents[]. | string | OuiYes | Adresse de téléchargement à ajouter à la base URL de l’API. Le jeton Bearer reste nécessaire.Download address to append to the API base URL. A Bearer token is still required. Voir comment télécharger le fichier.See how to download the file. |
| HTTP | SignificationMeaning |
|---|---|
| 200 | Requête réussie.Success |
| 400 | Requête invalide. Consultez le message d’erreur.Request rejected |
| 401 | Jeton absent, invalide ou expiré.Missing or invalid token |
| 403 | Cet accès ne permet pas cette opération.Operation not allowed |
| 404 | Ressource introuvable ou inaccessible à ce compte.Resource absent or outside account scope |
| 409 | La requête entre en conflit avec une opération ou un état existant.Request rejected |
| 413 | Le contenu envoyé dépasse la taille autorisée.Request rejected |
| 415 | Le format envoyé n’est pas accepté.Request rejected |
| 422 | Une ou plusieurs données sont invalides. Consultez les détails de l’erreur.Request rejected |
| 429 | Trop de requêtes. Retry-After indique le délai d’attente en secondes.Rate limit reached. Retry-After is in seconds |
| 503 | Service temporairement indisponible.Temporarily unavailable. no partial creation |
Lister les statuts possiblesList possible statuses
/v1/verification-statusesRenvoie les statuts possibles des points de vérification, sans doublon de code connu. Ce catalogue est commun aux intégrations : tous les statuts ne concernent pas nécessairement vos dossiers. Accept-Language permet de choisir fr ou en.Returns possible verification statuses, with no duplicate known codes. This catalogue is shared across integrations: not every status necessarily applies to your cases. Accept-Language selects fr or en.
| ChampField | Type / obligationType / requirement | DescriptionDescription |
|---|---|---|
Accept-Language | header · string · facultatifoptional | fr (défaut) ou en pour les libellés de restitution. Les codes restent stables.fr (default) or en for response labels. Codes remain stable. |
Exemple de requêteRequest example
curl --fail-with-body --request GET "https://api.verifcv.com/v1/verification-statuses" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Accept: application/json"<?php
$ACCESS_TOKEN = getenv('ACCESS_TOKEN');
$ch = curl_init('https://api.verifcv.com/v1/verification-statuses');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $ACCESS_TOKEN,
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
echo $response;GET https://api.verifcv.com/v1/verification-statuses HTTP/1.1
Host: api.verifcv.com
Authorization: Bearer <ACCESS_TOKEN>
Accept: application/jsonCette liste présente les codes de statut disponibles et leurs libellés. Pour consulter le statut actuel d’une vérification, utilisez les informations renvoyées dans le détail du dossier.This list provides the available status codes and their labels. To retrieve a verification’s current status, use the information returned in the case details.
De nouveaux statuts peuvent être ajoutés. Pour l’affichage, privilégiez le libellé renvoyé avec chaque vérification, y compris lorsque votre logiciel ne reconnaît pas encore son code.New statuses may be added. For display, use the label returned with each verification, including when your software does not yet recognize its code.
Exemples de réponseResponse examples
{
"data": [
{
"code": "in_progress",
"label": "En cours"
},
{
"code": "waiting_candidate",
"label": "En attente candidat"
},
{
"code": "graduated",
"label": "Diplômé"
}
]
}{
"error": {
"code": "invalid_token",
"message": "A valid access token is required.",
"details": [],
"request_id": "req_e57e87d786f068ec6cc8cefa4821f2a8"
}
}Structure complète de la réponse et codes HTTPFull response structure and HTTP codes
| ChampField | TypeType | Toujours présentAlways present | DescriptionDescription |
|---|---|---|---|
data | object[] | OuiYes | Statuts possibles. Les codes connus sont uniques ; les libellés distincts avec le code unmapped restent séparés.Possible statuses. Known codes are unique; distinct unmapped labels remain separate. |
data[]. | string | OuiYes | Code API indépendant de la langue. unmapped peut désigner plusieurs résultats distincts.Language-independent API code. unmapped can occur for distinct results. |
data[]. | string | OuiYes | Libellé représentatif dans la langue demandée.Representative label in the requested language. |
| HTTP | SignificationMeaning |
|---|---|
| 200 | Requête réussie.Success |
| 400 | Requête invalide. Consultez le message d’erreur.Request rejected |
| 401 | Jeton absent, invalide ou expiré.Missing or invalid token |
| 403 | Cet accès ne permet pas cette opération.Operation not allowed |
| 404 | Ressource introuvable ou inaccessible à ce compte.Resource absent or outside account scope |
| 409 | La requête entre en conflit avec une opération ou un état existant.Request rejected |
| 413 | Le contenu envoyé dépasse la taille autorisée.Request rejected |
| 415 | Le format envoyé n’est pas accepté.Request rejected |
| 422 | Une ou plusieurs données sont invalides. Consultez les détails de l’erreur.Request rejected |
| 429 | Trop de requêtes. Retry-After indique le délai d’attente en secondes.Rate limit reached. Retry-After is in seconds |
| 503 | Service temporairement indisponible.Temporarily unavailable. no partial creation |
Consulter l’historiqueRead history
/v1/cases/{reference}/historyHistorique visible dans l’espace client, du plus ancien au plus récent, sans notes internes. Le filtre since permet de récupérer les événements depuis une date donnée, incluse. La pagination utilise limit et offset, sans snapshot. Suivez le lien next pour passer à la page suivante. Les dates occurred_at sont des timestamps Unix en secondes.Client-visible history from oldest to newest, without internal notes. The optional since filter selects events on or after a given date. Uses limit/offset pagination without a snapshot; follow next. occurred_at values are Unix timestamps in seconds.
| ChampField | Type / obligationType / requirement | DescriptionDescription |
|---|---|---|
reference | path · string · requisrequired | Référence dossier générée par VerifCV et renvoyée à la création.Case reference generated by VerifCV and returned on creation. |
limit | query · integer · facultatifoptional | Taille de page : défaut 50, minimum 1, maximum 100.Page size: default 50, minimum 1, maximum 100. |
offset | query · integer · facultatifoptional | Décalage à partir de 0. Utilisez next pour les pages suivantes.Offset starting at 0; use next for subsequent pages. |
since | query · integer · facultatifoptional | Événements survenus à partir de cette date, incluse, en secondes Unix UTC. Sans ce filtre, tout l’historique visible est accessible par pagination.Events occurring on or after this date, in Unix UTC seconds. Without this filter, the full visible history is available through pagination. |
Accept-Language | header · string · facultatifoptional | fr (défaut) ou en pour les libellés de restitution. Les codes restent stables.fr (default) or en for response labels. Codes remain stable. |
Exemple de requêteRequest example
curl --fail-with-body --request GET "https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/history?limit=50&offset=0" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Accept: application/json"<?php
$ACCESS_TOKEN = getenv('ACCESS_TOKEN');
$ch = curl_init('https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/history?limit=50&offset=0');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $ACCESS_TOKEN,
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
echo $response;GET https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/history?limit=50&offset=0 HTTP/1.1
Host: api.verifcv.com
Authorization: Bearer <ACCESS_TOKEN>
Accept: application/jsonPour demander les libellés anglais, ajoutez l’en-tête Accept-Language: en. Les codes restent identiques.To request English labels, add the Accept-Language: en header. Codes stay unchanged.
Exemples de réponseResponse examples
{
"data": [
{
"id": "910001",
"occurred_at": 1792922400,
"label": "Envoi du dossier",
"verification_id": null,
"details": null
},
{
"id": "910002",
"occurred_at": 1792926600,
"label": "CV Validé",
"verification_id": null,
"details": null
},
{
"id": "910003",
"occurred_at": 1792927200,
"label": "Envoi candidat",
"verification_id": null,
"details": null
},
{
"id": "910004",
"occurred_at": 1792948320,
"label": "Autorisation signée",
"verification_id": "800",
"details": null
},
{
"id": "910005",
"occurred_at": 1792948321,
"label": "En cours diplôme : ",
"verification_id": "801",
"details": "Master en informatique (Université Exemple)"
},
{
"id": "910006",
"occurred_at": 1793013600,
"label": "Relance candidat automatique",
"verification_id": null,
"details": null
},
{
"id": "910007",
"occurred_at": 1793035200,
"label": "Retour candidat : ",
"verification_id": "802",
"details": "Développeuse informatique (Société Exemple)"
},
{
"id": "910008",
"occurred_at": 1793035500,
"label": "Retour candidat : ",
"verification_id": "802",
"details": "Développeuse informatique (Société Exemple)"
},
{
"id": "910009",
"occurred_at": 1793035620,
"label": "Retour candidat : ",
"verification_id": "801",
"details": "Master en informatique (Université Exemple)"
},
{
"id": "910010",
"occurred_at": 1793152800,
"label": "Acceptation info candidat",
"verification_id": null,
"details": null
},
{
"id": "910011",
"occurred_at": 1793152805,
"label": "Acceptation info candidat : ",
"verification_id": "801",
"details": "Master en informatique (Université Exemple)"
},
{
"id": "910012",
"occurred_at": 1793152820,
"label": "Acceptation info candidat : ",
"verification_id": "802",
"details": "Développeuse informatique (Société Exemple)"
},
{
"id": "910013",
"occurred_at": 1793152825,
"label": "Mail employeur : ",
"verification_id": "802",
"details": "Développeuse informatique (Société Exemple)"
},
{
"id": "910014",
"occurred_at": 1793152840,
"label": "Acceptation info candidat : ",
"verification_id": "802",
"details": "Développeuse informatique (Société Exemple)"
},
{
"id": "910015",
"occurred_at": 1793152845,
"label": "Mail employeur : ",
"verification_id": "802",
"details": "Développeuse informatique (Société Exemple)"
},
{
"id": "910016",
"occurred_at": 1793152860,
"label": "Relance candidat manuel",
"verification_id": null,
"details": null
},
{
"id": "910017",
"occurred_at": 1793157180,
"label": "Relance candidat manuel",
"verification_id": null,
"details": null
},
{
"id": "910018",
"occurred_at": 1793182680,
"label": "Retour candidat (avec copie de diplôme) : ",
"verification_id": "801",
"details": "Master en informatique (Université Exemple)"
},
{
"id": "910019",
"occurred_at": 1793182740,
"label": "Retour candidat (avec certificat) : ",
"verification_id": "802",
"details": "Développeuse informatique (Société Exemple)"
},
{
"id": "910020",
"occurred_at": 1793210040,
"label": "Retour candidat (avec certificat) : ",
"verification_id": "802",
"details": "Développeuse informatique (Société Exemple)"
}
],
"pagination": {
"limit": 50,
"offset": 0,
"total": 20,
"next": null
}
}{
"error": {
"code": "validation_failed",
"message": "Invalid integer.",
"details": [
{
"field": "limit",
"code": "invalid"
}
],
"request_id": "req_c1f6815a5477d0bc09a94b7371b18adf"
}
}Structure complète de la réponse et codes HTTPFull response structure and HTTP codes
| ChampField | TypeType | Toujours présentAlways present | DescriptionDescription |
|---|---|---|---|
data | object[] | OuiYes | Événements de l’historique sur cette page.History events on this page. |
data[]. | string | OuiYes | Identifiant de l’événement.Identifier of the event. |
data[]. | integer | OuiYes | Date de l’événement, en secondes Unix UTC.Event time in Unix UTC seconds. |
data[]. | string | OuiYes | Libellé destiné à l’affichage.Display label. |
data[]. | string / null | OuiYes | Identifiant de la vérification concernée. Vaut null si l’événement concerne le dossier entier.Affected check ID. Null when the event concerns the whole case. |
data[]. | string / null | OuiYes | Informations complémentaires sur l’événement. Vaut null si elles sont absentes.Additional event information. Null when absent. |
pagination | object | OuiYes | Informations pour parcourir les pages de résultats.Information for browsing result pages. |
pagination. | integer | OuiYes | Nombre maximal d’éléments par page.Maximum number of items per page. |
pagination. | integer | OuiYes | Nombre d’éléments ignorés avant cette page. La première page commence à 0.Number of items skipped before this page. The first page starts at 0. |
pagination. | integer | OuiYes | Nombre total d’éléments correspondant à la recherche.Total number of matching items. |
pagination. | string / null | OuiYes | Adresse de la page suivante. Vaut null lorsqu’il n’y a plus de page.Next page address. Null when there are no more pages. |
| HTTP | SignificationMeaning |
|---|---|
| 200 | Requête réussie.Success |
| 400 | Requête invalide. Consultez le message d’erreur.Request rejected |
| 401 | Jeton absent, invalide ou expiré.Missing or invalid token |
| 403 | Cet accès ne permet pas cette opération.Operation not allowed |
| 404 | Ressource introuvable ou inaccessible à ce compte.Resource absent or outside account scope |
| 409 | La requête entre en conflit avec une opération ou un état existant.Request rejected |
| 413 | Le contenu envoyé dépasse la taille autorisée.Request rejected |
| 415 | Le format envoyé n’est pas accepté.Request rejected |
| 422 | Une ou plusieurs données sont invalides. Consultez les détails de l’erreur.Request rejected |
| 429 | Trop de requêtes. Retry-After indique le délai d’attente en secondes.Rate limit reached. Retry-After is in seconds |
| 503 | Service temporairement indisponible.Temporarily unavailable. no partial creation |
Lister les documentsList documents
/v1/cases/{reference}/documentsRetourne les documents accessibles avec leur nom, taille et lien relatif de téléchargement. verification_id rattache le fichier à un point. La valeur null signifie un document du dossier. L’accès aux fichiers reste soumis aux droits actuels.Returns accessible files with name, size and relative download link. verification_id links a file to a check; null identifies a case-level file. Current file permissions always apply.
| ChampField | Type / obligationType / requirement | DescriptionDescription |
|---|---|---|
reference | path · string · requisrequired | Référence dossier générée par VerifCV et renvoyée à la création.Case reference generated by VerifCV and returned on creation. |
Accept-Language | header · string · facultatifoptional | fr (défaut) ou en pour les libellés de restitution. Les codes restent stables.fr (default) or en for response labels. Codes remain stable. |
Exemple de requêteRequest example
curl --fail-with-body --request GET "https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/documents" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Accept: application/json"<?php
$ACCESS_TOKEN = getenv('ACCESS_TOKEN');
$ch = curl_init('https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/documents');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $ACCESS_TOKEN,
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
echo $response;GET https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/documents HTTP/1.1
Host: api.verifcv.com
Authorization: Bearer <ACCESS_TOKEN>
Accept: application/jsonExemples de réponseResponse examples
{
"data": [
{
"id": "6328fb86d4db5063ee0d70148151babc162433b0c525e39304064f8474f7a676",
"name": "diplome.pdf",
"content_type": "application/pdf",
"size": 24576,
"verification_id": 801,
"download_url": "/v1/cases/VCV-0123456789abcdef0123456789abcdef/documents/6328fb86d4db5063ee0d70148151babc162433b0c525e39304064f8474f7a676"
}
]
}{
"error": {
"code": "validation_failed",
"message": "Unknown fields.",
"details": [
{
"field": "verification_id",
"code": "unknown_field"
}
],
"request_id": "req_f85bc4dcf7846758ff4254c11b1cf4ed"
}
}Consulter la référence des identifiants : profil, point du catalogue, vérification du dossier et document.See the identifier reference: profile, catalogue slot, case verification and document.
Structure complète de la réponse et codes HTTPFull response structure and HTTP codes
| ChampField | TypeType | Toujours présentAlways present | DescriptionDescription |
|---|---|---|---|
data | object[] | OuiYes | Liste des documents accessibles du dossier.List of available case documents. |
data[]. | string | OuiYes | Identifiant du document utilisé dans son URL de téléchargement. Il ne révèle pas son chemin de stockage.Document ID used in its download URL. It does not reveal its storage path. |
data[]. | string | OuiYes | Nom proposé pour enregistrer le fichier. Votre logiciel peut le renommer.Suggested filename. Your software can rename it. |
data[]. | string | OuiYes | Format du fichier, par exemple application/pdf.File media type, for example application/pdf. |
data[]. | integer | OuiYes | Taille du fichier en octets.File size in bytes. |
data[]. | integer / null | OuiYes | Identifiant de la vérification associée au document. Vaut null si le document est général.ID of the check associated with the document. Null for a general document. |
data[]. | string | OuiYes | Adresse de téléchargement à ajouter à la base URL de l’API. Le jeton Bearer reste nécessaire.Download address to append to the API base URL. A Bearer token is still required. Voir comment télécharger le fichier.See how to download the file. |
| HTTP | SignificationMeaning |
|---|---|
| 200 | Requête réussie.Success |
| 400 | Requête invalide. Consultez le message d’erreur.Request rejected |
| 401 | Jeton absent, invalide ou expiré.Missing or invalid token |
| 403 | Cet accès ne permet pas cette opération.Operation not allowed |
| 404 | Ressource introuvable ou inaccessible à ce compte.Resource absent or outside account scope |
| 409 | La requête entre en conflit avec une opération ou un état existant.Request rejected |
| 413 | Le contenu envoyé dépasse la taille autorisée.Request rejected |
| 415 | Le format envoyé n’est pas accepté.Request rejected |
| 422 | Une ou plusieurs données sont invalides. Consultez les détails de l’erreur.Request rejected |
| 429 | Trop de requêtes. Retry-After indique le délai d’attente en secondes.Rate limit reached. Retry-After is in seconds |
| 503 | Service temporairement indisponible.Temporarily unavailable. no partial creation |
Compléter un point avec un documentAdd a document to a check
/v1/cases/{reference}/documentsConsultez GET /v1/cases/{reference}, puis choisissez la vérification dans verifications. Transmettez son id dans metadata.verification_id.can_upload_document indique si vous pouvez envoyer un document. En général, l’ajout est refusé si un document est déjà présent. Dans certains cas, un remplacement est autorisé et can_upload_document vaut alors true. La pièce reçue sera ensuite contrôlée par un opérateur.Retrieve GET /v1/cases/{reference}, then choose the check in verifications. Send its id as metadata.verification_id.can_upload_document indicates whether you can send a document. Uploading is generally refused when a document is already present. In some cases, replacement is allowed and can_upload_document is then true. The received document will then be reviewed by an operator.
| ChampField | Type / obligationType / requirement | DescriptionDescription |
|---|---|---|
reference | path · string · requisrequired | Référence dossier générée par VerifCV et renvoyée à la création.Case reference generated by VerifCV and returned on creation. |
Idempotency-Key | header · string · requisrequired | Clé de 16 à 128 caractères : lettres ASCII, chiffres et . _ : -. Générée par votre logiciel, unique pour chaque nouvelle opération et conservée pour ses nouvelles tentatives pendant sept jours. Voir comment éviter les doublons.16-128 characters: ASCII letters, digits and . _ : -. Generated by your software, unique for each new operation and retained for retries during seven days. See how to prevent duplicates. |
La requête contient deux parties multipart : metadata avec verification_id, et document avec le fichier.The request contains two multipart parts: metadata containing verification_id, and document containing the file.
{
"verification_id": "801"
}Exemple de requêteRequest example
curl --fail-with-body --request POST "https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/documents" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
--form 'metadata=@document-metadata.json;type=application/json' \
--form 'document=@diplome.pdf;type=application/pdf'<?php
$ACCESS_TOKEN = getenv('ACCESS_TOKEN');
$IDEMPOTENCY_KEY = getenv('IDEMPOTENCY_KEY');
$ch = curl_init('https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/documents');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $ACCESS_TOKEN,
'Idempotency-Key: ' . $IDEMPOTENCY_KEY,
],
CURLOPT_POSTFIELDS => [
'metadata' => '{"verification_id": "801"}',
'document' => new CURLFile(__DIR__ . '/diplome.pdf', 'application/pdf', 'diplome.pdf'),
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
echo $response;Le contenu des fichiers est représenté ici par un texte indicatif. Votre bibliothèque HTTP transmet les fichiers et génère le séparateur multipart (boundary).File contents are represented here by placeholder text. Your HTTP library sends the files and generates the multipart boundary.
POST https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/documents HTTP/1.1
Host: api.verifcv.com
Authorization: Bearer <ACCESS_TOKEN>
Idempotency-Key: <IDEMPOTENCY_KEY>
Content-Type: multipart/form-data; boundary=VerifCVExampleBoundary
--VerifCVExampleBoundary
Content-Disposition: form-data; name="metadata"
Content-Type: application/json
{
"verification_id": "801"
}
--VerifCVExampleBoundary
Content-Disposition: form-data; name="document"; filename="diplome.pdf"
Content-Type: application/pdf
<binary bytes: diplome.pdf>
--VerifCVExampleBoundary--Exemples de réponseResponse examples
{
"id": "6328fb86d4db5063ee0d70148151babc162433b0c525e39304064f8474f7a676",
"name": "diplome.pdf",
"content_type": "application/pdf",
"size": 24576,
"verification_id": 801,
"download_url": "/v1/cases/VCV-0123456789abcdef0123456789abcdef/documents/6328fb86d4db5063ee0d70148151babc162433b0c525e39304064f8474f7a676"
}{
"error": {
"code": "document_exists",
"message": "This document slot is already filled.",
"details": [],
"request_id": "req_6e17230ebf000d499cacb21abf22c0dc"
}
}Consulter la référence des identifiants : profil, point du catalogue, vérification du dossier et document.See the identifier reference: profile, catalogue slot, case verification and document.
Structure complète de la réponse et codes HTTPFull response structure and HTTP codes
| ChampField | TypeType | Toujours présentAlways present | DescriptionDescription |
|---|---|---|---|
id | string | OuiYes | Identifiant du document utilisé dans son URL de téléchargement. Il ne révèle pas son chemin de stockage.Document ID used in its download URL. It does not reveal its storage path. |
name | string | OuiYes | Nom proposé pour enregistrer le fichier. Votre logiciel peut le renommer.Suggested filename. Your software can rename it. |
content_type | string | OuiYes | Format du fichier, par exemple application/pdf.File media type, for example application/pdf. |
size | integer | OuiYes | Taille du fichier en octets.File size in bytes. |
verification_id | integer / null | OuiYes | Identifiant de la vérification associée au document. Vaut null si le document est général.ID of the check associated with the document. Null for a general document. |
download_url | string | OuiYes | Adresse de téléchargement à ajouter à la base URL de l’API. Le jeton Bearer reste nécessaire.Download address to append to the API base URL. A Bearer token is still required. Voir comment télécharger le fichier.See how to download the file. |
| HTTP | SignificationMeaning |
|---|---|
| 201 | Création réussie.Success |
| 400 | Requête invalide. Consultez le message d’erreur.Request rejected |
| 401 | Jeton absent, invalide ou expiré.Missing or invalid token |
| 403 | Cet accès ne permet pas cette opération.Operation not allowed |
| 404 | Ressource introuvable ou inaccessible à ce compte.Resource absent or outside account scope |
| 409 | La requête entre en conflit avec une opération ou un état existant.Request rejected |
| 413 | Le contenu envoyé dépasse la taille autorisée.Request rejected |
| 415 | Le format envoyé n’est pas accepté.Request rejected |
| 422 | Une ou plusieurs données sont invalides. Consultez les détails de l’erreur.Request rejected |
| 429 | Trop de requêtes. Retry-After indique le délai d’attente en secondes.Rate limit reached. Retry-After is in seconds |
| 503 | Service temporairement indisponible.Temporarily unavailable. no partial creation |
Télécharger le rapportDownload the report
/v1/cases/{reference}/reportTélécharge le rapport final par défaut, ou le rapport provisoire avec kind=interim. L’API renvoie le rapport demandé si votre accès le permet et si ce rapport est disponible. Sinon, elle retourne une erreur sans le remplacer par un autre rapport. Pour télécharger celui annoncé dans le détail du dossier, utilisez report.download_url lorsque report.available vaut true.Downloads the final report by default, or the interim report with kind=interim. The requested report must be permitted and available; otherwise the API returns an error. There is no fallback to another report type. To download the report advertised in case detail, use report.download_url when report.available is true.
| ChampField | Type / obligationType / requirement | DescriptionDescription |
|---|---|---|
reference | path · string · requisrequired | Référence dossier générée par VerifCV et renvoyée à la création.Case reference generated by VerifCV and returned on creation. |
Accept-Language | header · string · facultatifoptional | fr (défaut) ou en pour les libellés de restitution. Les codes restent stables.fr (default) or en for response labels. Codes remain stable. |
kind | query · string · facultatifoptional | Utilisez final pour le rapport final ou interim pour le provisoire. Sans ce paramètre, le rapport final est demandé.Defaults to final; interim requests the interim report. No automatic fallback. |
Télécharger le rapport finalDownload the final report
curl --fail --request GET "https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/report" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--output "rapport.pdf"<?php
$ACCESS_TOKEN = getenv('ACCESS_TOKEN');
$ch = curl_init('https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/report');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $ACCESS_TOKEN,
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
if (file_put_contents(__DIR__ . '/rapport.pdf', $response) === false) {
throw new RuntimeException("Unable to save file");
}GET https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/report HTTP/1.1
Host: api.verifcv.com
Authorization: Bearer <ACCESS_TOKEN>Télécharger le rapport provisoireDownload the interim report
Le rapport provisoire est demandé avec kind=interim. Il doit être autorisé pour votre compte et disponible pour ce dossier. La réponse est directement un fichier PDF.Request the interim report with kind=interim. It must be permitted for your account and available for this case. The response is a PDF file.
curl --fail --request GET "https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/report?kind=interim" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--output "rapport-provisoire.pdf"<?php
$ACCESS_TOKEN = getenv('ACCESS_TOKEN');
$ch = curl_init('https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/report?kind=interim');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $ACCESS_TOKEN,
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
if (file_put_contents(__DIR__ . '/rapport-provisoire.pdf', $response) === false) {
throw new RuntimeException("Unable to save file");
}GET https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/report?kind=interim HTTP/1.1
Host: api.verifcv.com
Authorization: Bearer <ACCESS_TOKEN>Exemples de réponseResponse examples
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="document"; filename*=UTF-8''document.pdf
[binary file bytes]{
"error": {
"code": "not_found",
"message": "Report not available.",
"details": [],
"request_id": "req_d3a56a3692fafbec00823a77d377271e"
}
}Structure complète de la réponse et codes HTTPFull response structure and HTTP codes
| HTTP | SignificationMeaning |
|---|---|
| 200 | Le fichier est renvoyé après vérification des droits.Authenticated download. never a public storage URL. |
| 400 | Requête invalide. Consultez le message d’erreur.Request rejected |
| 401 | Jeton absent, invalide ou expiré.Missing or invalid token |
| 403 | Cet accès ne permet pas cette opération.Operation not allowed |
| 404 | Ressource introuvable ou inaccessible à ce compte.Resource absent or outside account scope |
| 409 | La requête entre en conflit avec une opération ou un état existant.Request rejected |
| 413 | Le contenu envoyé dépasse la taille autorisée.Request rejected |
| 415 | Le format envoyé n’est pas accepté.Request rejected |
| 422 | Une ou plusieurs données sont invalides. Consultez les détails de l’erreur.Request rejected |
| 429 | Trop de requêtes. Retry-After indique le délai d’attente en secondes.Rate limit reached. Retry-After is in seconds |
| 503 | Service temporairement indisponible.Temporarily unavailable. no partial creation |
Télécharger un documentDownload a document
/v1/cases/{reference}/documents/{document_id}Télécharge le fichier identifié par document_id. Cette route correspond au download_url de la liste des documents. Un jeton Bearer valide et les droits d’accès au fichier sont requis.Downloads the file identified by document_id. This route matches the download_url in the document list. A valid Bearer token and permission to access the file are required.
| ChampField | Type / obligationType / requirement | DescriptionDescription |
|---|---|---|
reference | path · string · requisrequired | Référence dossier générée par VerifCV et renvoyée à la création.Case reference generated by VerifCV and returned on creation. |
document_id | path · string · requisrequired | Identifiant opaque reçu dans documents[].id. Retrouver l’identifiant du document.Opaque identifier from documents[].id. Find the document ID. |
Accept-Language | header · string · facultatifoptional | fr (défaut) ou en pour les libellés de restitution. Les codes restent stables.fr (default) or en for response labels. Codes remain stable. |
Exemple de requêteRequest example
curl --fail --request GET "https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/documents/6328fb86d4db5063ee0d70148151babc162433b0c525e39304064f8474f7a676" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--output "document.pdf"<?php
$ACCESS_TOKEN = getenv('ACCESS_TOKEN');
$ch = curl_init('https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/documents/6328fb86d4db5063ee0d70148151babc162433b0c525e39304064f8474f7a676');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $ACCESS_TOKEN,
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
if (file_put_contents(__DIR__ . '/document.pdf', $response) === false) {
throw new RuntimeException("Unable to save file");
}GET https://api.verifcv.com/v1/cases/VCV-0123456789abcdef0123456789abcdef/documents/6328fb86d4db5063ee0d70148151babc162433b0c525e39304064f8474f7a676 HTTP/1.1
Host: api.verifcv.com
Authorization: Bearer <ACCESS_TOKEN>Exemples de réponseResponse examples
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="document"; filename*=UTF-8''document.pdf
[binary file bytes]{
"error": {
"code": "not_found",
"message": "Document not found.",
"details": [],
"request_id": "req_9964da722490d2b52af5d72f46eff737"
}
}Structure complète de la réponse et codes HTTPFull response structure and HTTP codes
| HTTP | SignificationMeaning |
|---|---|
| 200 | Le fichier est renvoyé après vérification des droits.Authenticated download. never a public storage URL. |
| 400 | Requête invalide. Consultez le message d’erreur.Request rejected |
| 401 | Jeton absent, invalide ou expiré.Missing or invalid token |
| 403 | Cet accès ne permet pas cette opération.Operation not allowed |
| 404 | Ressource introuvable ou inaccessible à ce compte.Resource absent or outside account scope |
| 409 | La requête entre en conflit avec une opération ou un état existant.Request rejected |
| 413 | Le contenu envoyé dépasse la taille autorisée.Request rejected |
| 415 | Le format envoyé n’est pas accepté.Request rejected |
| 422 | Une ou plusieurs données sont invalides. Consultez les détails de l’erreur.Request rejected |
| 429 | Trop de requêtes. Retry-After indique le délai d’attente en secondes.Rate limit reached. Retry-After is in seconds |
| 503 | Service temporairement indisponible.Temporarily unavailable. no partial creation |
Télécharger un document ou un rapportDownload a document or report
| AppelRequest | RésultatResult |
|---|---|
| GET /v1/cases/{reference}/documents | Renvoie du JSON : liste des fichiers, noms et download_url. Aucun fichier n’est téléchargé à cette étape.Returns JSON: file list, names and download_url values. No file is downloaded at this step. |
| GET /v1/cases/{reference}/documents/{document_id} | Télécharge le document. Le champ download_url contient l’adresse de cette route, avec les identifiants déjà renseignés.Returns the binary file at the address provided in download_url. |
| GET /v1/cases/{reference}/report | Renvoie le rapport final en PDF. Pour un provisoire autorisé et disponible, ajouter ?kind=interim. Aucun remplacement automatique par l’autre rapport.Returns the final PDF report. For an allowed, available interim report, add ?kind=interim. There is no automatic fallback to the other report. |
Utiliser le lien download_urlUse the download_url link
Le champ download_url contient le chemin du fichier à télécharger. Ajoutez la base URL de votre environnement, puis appelez cette adresse avec votre jeton Bearer. L’URL seule ne donne pas accès au fichier : les droits sont vérifiés à chaque téléchargement.Prefix the relative download_url with your environment base URL and send your Bearer token. The URL alone does not grant access: permissions are checked on every download.
Dans cet exemple, DOWNLOAD_URL contient la valeur du champ download_url reçu dans la réponse. En PHP, $document représente le document choisi dans data. Dans la vue HTTP, remplacez <download_url> par cette même valeur.In this example, DOWNLOAD_URL contains the download_url field received in the response. In PHP, $document is the selected document from data. In the HTTP view, replace <download_url> with that same value.
curl --fail --request GET "https://api.verifcv.com${DOWNLOAD_URL}" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--output "document.pdf"<?php
$ACCESS_TOKEN = getenv('ACCESS_TOKEN');
$url = 'https://api.verifcv.com' . $document['download_url'];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $ACCESS_TOKEN,
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("HTTP " . $status . ": " . $response);
}
if (file_put_contents(__DIR__ . '/document.pdf', $response) === false) {
throw new RuntimeException("Unable to save file");
}GET <download_url> HTTP/1.1
Host: api.verifcv.com
Authorization: Bearer <ACCESS_TOKEN>La réponse contient le fichier binaire. En cas d’erreur, l’API renvoie du JSON. Vérifiez le code HTTP avant d’enregistrer le fichier.The response contains the binary file. On error, the API returns JSON. Check the HTTP status before saving the file.
Pour un rapport, utilisez de la même façon report.download_url lorsque report.available vaut true. Le lien sélectionne déjà le rapport final ou provisoire indiqué par report.kind. Voir les exemples de rapports.For a report, use report.download_url in the same way when report.available is true. The link already selects the final or interim report identified by report.kind. See report examples.
Interpréter les résultatsInterpret results
| status.code | Statut globalOverall status |
|---|---|
| in_progress | En cours / In progress |
| completed | Terminée / Completed |
| refused | Refusée / Refused |
| cancelled | Annulée / Canceled |
| unsigned | Non signée / Unsigned |
| suspended | En suspend / Suspended |
Le statut global décrit l’avancement du dossier. Le résultat de chaque point est détaillé dans les statuts des vérifications. Pour récupérer le rapport disponible, utilisez report.download_url lorsque report.available vaut true.The global status describes case progress. Each check result is described in verification statuses. To retrieve the available report, use report.download_url when report.available is true.
Lire les statuts des vérificationsRead verification statuses
Les champs status.label et status.color reprennent le libellé et la couleur affichés dans l’application client, selon la langue et la configuration du dossier. status.code est l’identifiant technique de cette présentation, pas un libellé à afficher.status.label and status.color match the label and color displayed in the client application, according to the case language and configuration. status.code is the technical identifier for this presentation, not a display label.
Codes des statutsStatus codes
Pour obtenir la liste à jour des statuts possibles, utilisez GET /v1/verification-statuses.For the current list of possible statuses, use GET /v1/verification-statuses.
Principaux statuts possiblesMain possible statuses
Voici les principaux messages de suivi que vous pouvez recevoir.These are the main progress messages you may receive.
| status.code | LibelléLabel |
|---|---|
| in_progress | En cours.In progress. |
| waiting_candidate | En attente candidat.Waiting for candidate. |
| waiting_school | En attente école.Waiting for school. |
| waiting_employer | En attente employeur.Waiting for employer. |
| waiting_verification | En attente vérif.En attente vérif. |
| employer_on_leave | Employeur en congés.Employer on leave. |
| cancelled | Annulée.Canceled. |
| refused | Refusée.Refused. |
| reference_in_progress | Prise de référence en cours.Prise de référence en cours. |
| diploma_in_progress | Diplôme en cours de vérification.Diplôme en cours de vérification. |
| candidate_documents_missing | Non retour documents candidat.Candidate documents not yet uploaded. |
| candidate_information_missing | Information candidat manquante.Information candidat manquante. |
Exemples de résultatsExample results
| status.code | Exemple de libelléExample label |
|---|---|
| graduated | Diplômé.Graduated. |
| not_graduated | Non diplômé.Not graduated. |
| school_closed | École fermée.School closed. |
| reference_validated | Ref Valide.Reference valid. |
| identity_validated | ID Validée.ID checked. |
D’autres codes existent selon les vérifications et leur configuration. Utilisez label et color pour l’affichage, même si votre intégration ne reconnaît pas le code. Un code déjà publié conserve son sens.Other codes exist depending on the checks and their configuration. Use label and color for display, even if your integration does not recognize the code. Published codes retain their meaning.
Un état métier pas encore associé à un code explicite renvoie unmapped, avec le libellé et la couleur de l’application client.A business state not yet assigned an explicit code returns unmapped with the client application label and color.
Couleurs des vérificationsVerification colors
Ces couleurs reprennent l’affichage client. Les exemples ci-dessous ne sont pas exhaustifs. Un même code de statut peut avoir plusieurs couleurs. Utilisez la valeur status.color renvoyée.These colors reproduce the client display. The examples below are not exhaustive. The same status code may have different colors. Use the returned status.color value.
| CouleurColor | status.color | Exemples d’affichageDisplay examples |
|---|---|---|
| VertGreen | #00a65a | Diplômé, ID Validée, Dérogé.Graduated, ID checked, Derogated. |
| OrangeOrange | #f39c12 | Attention Requise, Plus valide.Attention required, No longer valid. |
| RougeRed | #dd4b39 | Non diplômé, Informations inexactes.Not graduated, Inaccurate information. |
| Gris clairLight gray | #d2d6de | En cours, Document non vérifié.In progress, Document not verified. |
| Bleu cyanCyan | #00c0ef | En attente candidat, Employeur en congés.Waiting for candidate, Employer on leave. |
| Gris foncéDark gray | #999999 | Annulée, Vérification impossible.Canceled, Verification impossible. |
| FuchsiaFuchsia | #f012be | En cours ou En attente candidat, selon le parcours.In progress or Waiting for candidate, depending on the workflow. |
| VioletPurple | #605ca8 | En attente école, En attente employeur.Waiting for school, Waiting for employer. |
| NoirBlack | #111111 | En attente candidat, selon le parcours.Waiting for candidate, depending on the workflow. |
| JauneYellow | #ffd805 | Prise de référence en cours, selon la configuration.Reference check in progress, depending on configuration. |
Droits et fonctionnalités disponiblesPermissions and available features
| Règle du compteAccount rule | Effet sur l’APIAPI effect |
|---|---|
| dossiers_personnels_uniquement | Limite listes, détails, historique, documents et rapports aux dossiers du compte de référence, même si le groupe partage ses dossiers.Restricts lists, details, history, documents and reports to the reference account’s cases, even with group sharing. |
| depot_confidentiel_autorise | Autorise confidential=true à la création pour son propre compte. Les habilitations ne sont pas modifiables par l’API.Allows confidential=true on creation for the reference account only. Permissions cannot be changed through the API. |
| consultation | Lecture seule : création et ajout refusés.Read-only: creation and uploads denied. |
| no_files | Accès aux fichiers et ajouts après création interdits. Le dépôt initial reste possible hors lecture seule.File access and post-creation uploads denied. Initial submission remains available unless read-only. |
| Partage / confidentialitéSharing / confidentiality | Déterminent les dossiers visibles, comme dans l’espace client.Determine visible cases, as in the client application. |
| Déposants autorisésPermitted submitters | Déterminent pour quels comptes déposer. Ne changent pas le périmètre de lecture.Determine which accounts may receive submissions. Do not expand read access. |
Les droits sont contrôlés à chaque appel. Une restriction prend effet même si le jeton est encore valide. Pour les pièces d’identité, les possibilités de remplacement dépendent du parcours du dossier, classique ou IDnow.Permissions are checked on every request. Restrictions take effect even while a token remains valid. Identity document replacement depends on the case workflow, either classic or IDnow.
Comprendre et traiter les erreursUnderstand and handle errors
{
"error": {
"code": "validation_failed",
"message": "profile_id is required.",
"details": [
{
"field": "profile_id",
"code": "required"
}
],
"request_id": "example-request-id"
}
}| HTTP | CauseCause | Action recommandéeRecommended action |
|---|---|---|
| 400 | Requête incorrecteMalformed request | Vérifier le format, notamment les paramètres OAuth.Check formatting, especially OAuth parameters. |
| 401 | Authentification absente ou invalideMissing or invalid authentication | Vérifier les identifiants et l’environnement. Renouveler un Bearer expiré.Check credentials and environment; replace an expired Bearer token. |
| 403 | Action interditeAction forbidden | Vérifier les droits de votre accès API. Ils restent les mêmes si vous changez de déposant.Check permissions; changing submitters does not bypass restrictions. |
| 404 | Ressource inaccessibleResource inaccessible | Vérifier référence, disponibilité et périmètre. Un dossier d’un autre compte n’est pas divulgué.Check reference, availability and access. Cases owned by others are not disclosed. |
| 409 | ConflitConflict | Lire error.code : clé réutilisée avec un autre contenu, document existant, sélection expirée ou référence historique ambiguë.Read error.code: changed content for a key, existing document, expired selection or ambiguous legacy reference. |
| 413 | Volume excessifPayload too large | Réduire la taille des fichiers ou du dépôt.Reduce file or request size. |
| 415 | Format refuséUnsupported format | Respecter les formats du point et envoyer un contenu réel compatible.Use permitted check formats and matching file content. |
| 422 | Validation refuséeValidation failed | Corriger les champs indiqués dans details. Vérifier les points et pièces.Correct details fields; check selected checks and files. |
| 429 | Quota dépasséRate limit exceeded | Attendre Retry-After secondes. Éviter les appels concurrents excessifs.Wait Retry-After seconds; avoid excessive concurrent requests. |
| 503 | Service temporairement indisponibleService temporarily unavailable | Attendre avant de réessayer, en gardant la même clé d’idempotence et le même contenu.Retry with backoff, keeping the same idempotency key and content. |
OAuth utilise son format standardOAuth uses its standard format
{
"error": "invalid_client",
"error_description": "Invalid client credentials."
}Les messages peuvent être en anglais : utilisez les codes pour votre logique et transmettez request_id au support pour une erreur métier. Ne stockez pas votre secret, votre jeton ou les documents candidats dans les journaux techniques.Messages may be in English: use codes for logic and provide request_id to support for business errors. Never include secrets, tokens or candidate documents in technical logs.
Limites de requêtesRate limits
| OpérationOperation | Limite par défautDefault limit | PérimètreScope |
|---|---|---|
| AuthentificationAuthentication | 30/min | Par adresse IPPer IP address |
| LectureReads | 120/min | Par intégrationPer integration |
| Création et ajout de piècesCreation and uploads | 20/min | Par intégrationPer integration |
| TéléchargementDownloads | 60/min | Par intégrationPer integration |
Ces limites sont configurables. En cas de réponse 429, attendez le nombre de secondes indiqué par Retry-After avant de réessayer.These limits are configurable. On a 429 response, wait the number of seconds specified by Retry-After before retrying.
Quel identifiant utiliser ?Which identifier should I use?
| IdentifiantIdentifier | Source de la valeurValue source | UtilisationUsage |
|---|---|---|
| profile_id | GET /v1/profiles : data[].id | Profil à fournir à la création si profile_required vaut true.Profile required at creation when profile_required is true. |
| point_id | Profil ou configuration : points[].point_idProfile or configuration: points[].point_id | Identifie un point du catalogue : points[].point_id. Sert à rattacher une pièce au dépôt initial dans documents[].point_id.Identifies a catalogue slot: points[].point_id. Used in documents[].point_id for initial attachments. |
| id_type | points[].id_type / verifications[].id_type | Identifie une famille de vérification. Deux diplômes peuvent partager id_type=3 tout en ayant deux point_id différents. Ce champ ne choisit pas la pièce à compléter.Identifies a verification family. Two diplomas can share id_type=3 with different point_id values. This field does not select a document slot. |
| verification_id | Dossier : verifications[].idCase: verifications[].id | Après création, utiliser verifications[].id du détail du dossier. À transmettre dans metadata.verification_id pour ajouter une pièce à ce point précis.After creation, use verifications[].id from the case detail. Send it as metadata.verification_id to add a document to that specific check. |
| reference | reference | Référence du dossier retournée à la création ou dans la liste. À conserver et à encoder dans les URL. Les références historiques peuvent contenir des espaces.Case reference returned at creation or in the list. Store it and URL-encode it; historical references may contain spaces. |
| document_id | documents[].id | Identifie le fichier à télécharger, sans révéler son chemin de stockage.Identifies the file to download without exposing its storage path. |
Fichier OpenAPIOpenAPI file
Le fichier OpenAPI décrit les routes, les paramètres et les réponses de l’API dans un format exploitable par vos outils. Vous pouvez l’utiliser pour préparer vos requêtes, générer un client ou vérifier la structure des données.The OpenAPI file describes API routes, parameters and responses in a machine-readable format. Use it to prepare requests, generate a client or validate data structures.
Télécharger le fichier OpenAPI (JSON)Download the OpenAPI file (JSON)
Versions et évolutionsVersions and changes
Version de l’API : V1. Documentation mise à jour le 17 novembre 2026.API version: V1. Documentation updated on 17 November 2026.
| RévisionRevision | ChangementsChanges |
|---|---|
| DocumentationDocumentation | Ajout du tableau des couleurs et clarification de l’utilisation des liens de téléchargement.Added the color table and clarified download link usage. |
| DocumentationDocumentation | Ajout des exemples de requêtes PHP et HTTP aux exemples cURL.Added PHP and HTTP request examples alongside cURL. |
Compatibilité V1V1 compatibility
Des champs et des codes peuvent être ajoutés aux réponses. Votre intégration doit continuer à fonctionner lorsqu’elle reçoit une valeur qu’elle ne connaît pas. Dans vos requêtes, envoyez uniquement les champs documentés.Response fields and codes may be added. Your integration must continue working when it receives an unfamiliar value. Send only documented fields in your requests.
Un changement qui nécessite d’adapter votre intégration sera annoncé avec les instructions de migration. Une évolution incompatible fera l’objet d’une nouvelle version majeure.A change requiring an update to your integration will be announced with migration instructions. Incompatible changes will use a new major version.