L’API Rapport de vérification détaillé récupère les résultats de vérification d’une transaction. Les données suivantes figurent dans le rapport :
Informations personnelles
Informations sur le document
Une URL SFT vers la photo de la pièce d’identité
Le score et le seuil associés à la vérification
Pour plus d’informations sur le téléchargement des photos de la pièce d’identité, reportez-vous à la Download image binary data.
Syntaxe
GET /api/transactions/id/detailed-verification-reportParamètres disponibles
Paramètres de la requête | ||
Nom | Type | Description |
|---|---|---|
id | Corde | Obligatoire. Il s’agit de l’identifiant unique de la vérification d’une seule personne. |
Exemples
Exemple de demande
curl --location --request GET 'http(s)://$host:$port/api/transactions/$TX_ID/detailed-verification-report' \
--header 'Authorization: Bearer $TENANT_ACCESS_TOKEN'Exemples de réponses
La réponse du rapport de vérification détaillé contient des informations sur les différentes étapes d’une transaction. Le contenu réel de la réponse dépend du statut IDV de la transaction.
Réponse de l’étape CreateVerification
À ce stade, la réponse couvre toutes les données qui ont été soumises avant le début du processus de vérification.
{
"id": "fe74D66E-6B51-8992-A169-E14C3c281E5f",
"result": "Undefined",
"status": "InProgress",
"stages": [
{
"stageId": 1,
"stageType": {
"title": "CreateVerification"
},
"attemptNumber": 1,
"result": "Passed",
"created": "2021-09-29T18:25:43.511Z",
"details": {
"personalInformation": {
"nameInformation": {
"forename": "John",
"surname": "Doe",
"birthSurname": "B"
},
"dateOfBirth": "1999-01-01",
"addressInformation": {
"flatOrApartmentNumber": 123,
"houseName": "MyHouse",
"houseNumber": 456,
"postCode": "MyPostCode",
"country": "MyCountry",
"countyOrProvince": "MyProvince",
"poBox": 1234,
"street": "MyStreet",
"town": "MyTown",
"city": "MyCity"
},
"mobilePhoneNumber": "+12345678900"
}
}
}
]
}Réponse d’étape AddProviderData
À ce stade, la réponse couvre toutes les données qui ont été extraites des ID fournis.
{
"stageId": 1,
"stageType": {
"service": "DocumentId",
"provider": "xyz",
"title": "AddProviderData"
},
"comment": "Identity Verification Data is successfully extracted from provider.",
"attemptNumber": 1,
"result": "Passed",
"created": "2023-03-22T12:37:35.065Z",
"details": {
"personalInformation": {
"documentsInformation": [
{
"documentElement": {
"type": "Passport",
"pages": [
{
"type": "PassportDataPage",
"url": "sfs://MyURL/default/Test_Tenant_ID/transactions/bf0d536d-3cb9-41b5-b158-8a5936169XXX/document/a5658e14-d174-47f6-8ab2-14da8257cXXX/jpeg"
}
]
},
"extractedDocumentSegments": [
{
"zone": "MergedZones",
"personalInformation": {
"nameInformation": {
"forename": "JOHN",
"surname": "DOE"
},
"dateOfBirth": "1980-01-01",
"gender": "Male",
"nationality": "GBR",
"addressInformation": {},
"documentElement": {
"type": "Passport",
"number": "123456789",
"issuingCountry": "GB",
"issuingAuthority": "HMPO",
"issueDate": "2018-08-09",
"expiryDate": "2029-05-09"
}
},
"providerSpecificData": {
"Document Class Name": "Passport",
"Issuing State Name": "United Kingdom (Citizen)",
"Issuing State Code": "GBR",
"Issue Date": "/Date(1533772800000)/",
"Document Class Code": "P",
"Biographic.ExpirationDate": "/Date(1872979200000)/",
"Nationality Name": "United Kingdom (Citizen)"
}
},
{
"zone": "Viz",
"personalInformation": {
"nameInformation": {
"forename": "JOHN",
"surname": "DOE"
},
"dateOfBirth": "1980-01-01",
"gender": "Male",
"addressInformation": {},
"documentElement": {
"number": "123456789",
"issuingAuthority": "HMPO",
"issueDate": "2018-08-09",
"expiryDate": "2029-05-09"
}
},
"providerSpecificData": {
"VIZ Nationality Name": "BRITISH CITIZEN",
"VIZ Issue Date": "/Date(1533772800000)/",
"VIZ Expiration Date": "/Date(1872979200000)/"
}
},
{
"zone": "Mrz",
"personalInformation": {
"nameInformation": {
"forename": "JOHN",
"surname": "DOE"
},
"dateOfBirth": "1980-01-01",
"gender": "Male",
"nationality": "GBR",
"addressInformation": {},
"documentElement": {
"number": "123456789",
"issuingCountry": "GB",
"expiryDate": "2029-05-09"
}
},
"providerSpecificData": {
"VI Issuing State Code": "GBR",
"VI Document Class Code": "P",
"VI Issuing State Name": "United Kingdom (Citizen)",
"VI Nationality Name": "United Kingdom (Citizen)",
"VI Expiration Date": "/Date(1872979200000)/"
}
},
{
"zone": "MergedZones",
"segmentCategory": "Type",
"personalInformation": {
"documentElement": {
"type": "Passport",
"issuingCountry": "GB"
}
},
"providerSpecificData": {
"Type.IssuerName": "United Kingdom (Citizen)",
"Type.IssueType": "ePassport",
"Type.CountryCode": "GBR",
"Type.IssuerCode": "GBR",
"Type.ClassName": "Passport",
"Type.ClassCode": "P"
}
},
{
"zone": "MergedZones",
"segmentCategory": "Front",
"personalInformation": {
"documentElement": {
"type": "Passport",
"issuingCountry": "GB"
}
},
"providerSpecificData": {
"Front.ClassCode": "P",
"Front.IssuerName": "United Kingdom (Citizen)",
"Front.ClassName": "Passport",
"Front.IssuerCode": "GBR",
"Front.IssueType": "ePassport",
"Front.CountryCode": "GBR"
}
}
]
}
]
}
}
}
TentativeVérification Intervention sur scène
À ce stade, la réponse couvre le résultat de la vérification pour un champ donné.
{
"stageId": 3,
"stageType": {
"service": "DocumentId",
"provider": "xyz",
"title": "AttemptVerification"
},
"attemptNumber": 1,
"result": "Passed",
"created": "2023-05-23T10:59:16.088Z",
"details": {
"matchers": [
{
"name": "document_number",
"result": "Match",
"behaviors": [
"AffectsVerificationAttemptResult"
],
"checks": [
{
"name": "document_number",
"description": "Compares document number submitted and extracted.",
"evaluated": "[1234567M123PB5, KB1234567]",
"operator": "Equivalent",
"evaluatedAgainst": "1234567M123PB5",
"result": "Passed",
"personalInformation": {
"documentsInformation": [
{
"documentElement": {
"number": "1234567M123PB5",
"pages": [
{
"type": "PassportDataPage",
"url": "sfs://MyURL/default/ONESPAN_IDV_LIVE/transactions/439dfba9-817a-433d-83c3-8c384a43f5de/document/d11196a9-31af-4b94-a154-2695c7d46a00/jpeg"
}
]
},
"extractedDocumentSegments": [
{
"zone": "MergedZones",
"personalInformation": {
"documentElement": {
"number": "KB1234567",
"identificationNumber": "1234567M123PB5"
}
}
}
]
}
]
}
}
]
},
{
"name": "date_of_birth",
"result": "Match",
"behaviors": [
"AffectsVerificationAttemptResult"
],
"checks": [
{
"name": "date_of_birth",
"description": "Compares date of birth submitted and extracted.",
"evaluated": "1986-10-16",
"operator": "EqualsTo",
"evaluatedAgainst": "1986-10-16",
"result": "Passed",
"personalInformation": {
"dateOfBirth": "1986-10-16",
"documentsInformation": [
{
"documentElement": {
"type": "Passport",
"pages": [
{
"type": "PassportDataPage",
"url": "sfs://MyURL/default/ONESPAN_IDV_LIVE/transactions/439dfba9-817a-433d-83c3-8c384a43f5de/document/d11196a9-31af-4b94-a154-2695c7d46a00/jpeg"
}
]
},
"extractedDocumentSegments": [
{
"zone": "MergedZones",
"personalInformation": {
"dateOfBirth": "1986-10-16"
}
}
]
}
]
}
}
]
},
{
"name": "date_of_expiry",
"result": "Match",
"behaviors": [
"AffectsVerificationAttemptResult"
],
"checks": [
{
"name": "date_of_expiry",
"description": "Checks that document expire date is today or later.",
"evaluated": "2023-12-15",
"operator": "GreaterOrEqualsTo",
"evaluatedAgainst": "2023-05-23",
"result": "Passed",
"personalInformation": {
"documentsInformation": [
{
"documentElement": {
"type": "Passport",
"pages": [
{
"type": "PassportDataPage",
"url": "sfs://MyURL/default/ONESPAN_IDV_LIVE/transactions/439dfba9-817a-433d-83c3-8c384a43f5de/document/d11196a9-31af-4b94-a154-2695c7d46a00/jpeg"
}
]
},
"extractedDocumentSegments": [
{
"zone": "MergedZones",
"personalInformation": {
"documentElement": {
"expiryDate": "2023-12-15"
}
}
}
]
}
]
}
}
]
},
{
"name": "document_supported",
"result": "Match",
"behaviors": [
"AffectsVerificationAttemptResult"
],
"checks": [
{
"name": "document_supported",
"description": "Compares a match of countries and supported document types.",
"evaluated": "{\"type\":\"P\",\"country\":\"GB\"}",
"operator": "Equivalent",
"evaluatedAgainst": "{\"type\":\"P\",\"country\":\"GB\"}",
"result": "Passed",
"personalInformation": {
"documentsInformation": [
{
"documentElement": {
"type": "Passport",
"issuingCountry": "GB",
"pages": [
{
"type": "PassportDataPage",
"url": "sfs://MyURL/default/ONESPAN_IDV_LIVE/transactions/439dfba9-817a-433d-83c3-8c384a43f5de/document/d11196a9-31af-4b94-a154-2695c7d46a00/jpeg"
}
]
},
"extractedDocumentSegments": [
{
"zone": "MergedZones",
"personalInformation": {
"documentElement": {
"type": "Passport",
"issuingCountry": "GB"
}
},
"providerSpecificData": {
"documentType": "XX_Passport_YYYY",
"DD_ExpeditionPlace_Out": "GBR",
"DD_IssuingCountry_Out": "GBR"
}
}
]
}
]
}
}
]
},
{
"name": "address_match",
"comment": "Some data was not supplied, the comparison cannot be executed.",
"result": "Error",
"behaviors": [
"ExecuteOnly"
],
"checks": [
{
"name": "address_match",
"description": "Compares address submitted and extracted.",
"operator": "Equivalent",
"evaluatedAgainst": "{\"houseNumber\":\"11\",\"postCode\":\"ABC123\",\"poBox\":\"1234\"}",
"result": "AnalysedDataInsufficient",
"personalInformation": {
"addressInformation": {
"houseNumber": "11",
"postCode": "ABC123",
"poBox": "1234"
},
"documentsInformation": [
{
"documentElement": {
"type": "Passport",
"pages": [
{
"type": "PassportDataPage",
"url": "sfs://MyURL/default/ONESPAN_IDV_LIVE/transactions/439dfba9-817a-433d-83c3-8c384a43f5de/document/d11196a9-31af-4b94-a154-2695c7d46a00/jpeg"
}
]
}
}
]
}
}
]
},
{
"name": "name",
"result": "Match",
"behaviors": [
"AffectsVerificationAttemptResult"
],
"checks": [
{
"name": "name",
"description": "Full name match: compares different name part submitted and extracted in order to determine how closely the submitted and extracted data is. Matching the calculated proximity is between 0.0 and 1.0 which is to be understood as a percentage of similarity.",
"evaluated": "1.0",
"operator": "GreaterOrEqualsTo",
"evaluatedAgainst": "1.0",
"result": "Passed",
"personalInformation": {
"nameInformation": {
"forename": "John",
"surname": "Doe"
},
"documentsInformation": [
{
"documentElement": {
"type": "Passport",
"pages": [
{
"type": "PassportDataPage",
"url": "sfs://MyURL/default/ONESPAN_IDV_LIVE/transactions/439dfba9-817a-433d-83c3-8c384a43f5de/document/d11196a9-31af-4b94-a154-2695c7d46a00/jpeg"
}
]
},
"extractedDocumentSegments": [
{
"zone": "MergedZones",
"personalInformation": {
"nameInformation": {
"forename": "JOHN",
"surname": "DOE"
}
}
}
]
}
]
}
}
]
},
{
"name": "face_similarity",
"result": "Match",
"behaviors": [
"AffectsVerificationAttemptResult"
],
"checks": [
{
"name": "face_similarity",
"description": "Determine how closely selfie(s) is(are) similar to picture of the person on the document.",
"evaluated": "0.9999998366743112",
"operator": "GreaterOrEqualsTo",
"evaluatedAgainst": "0.7",
"result": "Passed",
"personalInformation": {
"documentsInformation": [
{
"documentElement": {
"type": "Passport",
"pages": [
{
"type": "PassportDataPage",
"url": "sfs://MyURL/default/DTE_AGREEMENT_AUTOMATION_TEST/transactions/yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy/document/a0564f56-be41-4d94-ad3f-8069c132bec0/jpeg"
}
]
},
"analyzedData": [
{
"result": "0.9999998366743112",
"biometricInformation": {
"type": "Picture",
"detail": "Selfie",
"url": "sfs://MyURL/default/DTE_AGREEMENT_AUTOMATION_TEST/transactions/yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy/biometrics/23268a24-1d1f-420e-b33c-878bb313eef6/jpeg"
}
}
]
}
]
}
}
]
},
{
"name": "liveness_check",
"result": "Match",
"behaviors": [
"AffectsVerificationAttemptResult"
],
"checks": [
{
"name": "liveness_check",
"description": "Checks the liveness of the selfie(s).",
"evaluated": "1.0",
"operator": "GreaterOrEqualsTo",
"evaluatedAgainst": "0.95",
"result": "Passed",
"personalInformation": {
"documentsInformation": [
{
"documentElement": {
"type": "Passport",
"pages": [
{
"type": "PassportDataPage",
"url": "sfs://MyURL/default/DTE_AGREEMENT_AUTOMATION_TEST/transactions/yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy/document/a0564f56-be41-4d94-ad3f-8069c132bec0/jpeg"
}
]
},
"analyzedData": [
{
"result": "1.0",
"biometricInformation": {
"type": "Picture",
"detail": "Selfie",
"url": "sfs://MyURL/default/DTE_AGREEMENT_AUTOMATION_TEST/transactions/yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy/biometrics/23268a24-1d1f-420e-b33c-878bb313eef6/jpeg"
}
}
]
}
]
}
}
]
}
]
}
}
]
}
Codes d’état
| Code d’état | Nom | Description |
|---|---|---|
| 200 | D’ACCORD | Le rapport de vérification est récupéré avec succès. |
| 400 | Mauvaise demande | Le client a fourni une entrée non valide. |
| 401 | Non autorisée | Le client n’a pas fourni de jeton d’accès valide, ou a fourni un jeton d’accès qui manque un certain nombre de réclamations. Dans ce cas précis, pour des raisons de sécurité, aucun détail n’est fourni dans la réponse. |
| 404 | Introuvable | La ressource demandée n’a pas été trouvée. |
| 500 | Erreur de serveur interne | Le serveur a rencontré une condition inattendue qui l’a empêché de terminer la requête. |