{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2be54b91-0dc2-4de8-bf6c-bf0e1d67cfd1","name":"VerifID API","description":"Latest version: V3\n\nProtocols: HTTPS\n\nProduction:\n\nBase address: [https://verifid.ondato.com](https://verifid.ondato.com)\n\nSwagger: [https://verifid.ondato.com/swagger/index.html](https://verifid.ondato.com/swagger/index.html)\n\nBack-office: [https://bo.ondato.com](https://bo.ondato.com)\n\nSandbox:\n\nBase address: [https://sandbox-verifid.ondato.com](https://sandbox-verifid.ondato.com)\n\nAPI Swagger: [https://sandbox-verifid.ondato.com/swagger/index.html](https://sandbox-verifid.ondato.com/swagger/index.html)\n\nBack-office: [https://sandbox-bo.ondato.com](https://sandbox-bo.ondato.com)\n\n* * *\n\n

DESCRIPTION

\n\nVerifId customer identification API is used for KYC process.\n\nThe API provides third party applications with information belonging to the third party customer documents:\n\nDocument data:\n\n\n\nAlso this service compares persons face with the face in the provided document.\n\nThis API is closely linked with the Ondato Back-office. Once the VerifID service processes document data clients can view those identifications inside Ondato Back-office. Clients can also double check identification details (cross check) and manually reject or edit document data and then verify the identification.\n\nService short guide:\n\n

  1. Client authorizes its app with Ondato service and gets access token in response

  2. Client starts new identification session and a unique identificationId is returned

  3. Client uploads his customers photo or video together with his customer document files or uploads NFC data

  4. Client calls /verification/ endpoint and gets processed rule statuses if the client is happy with the result then it proceeds to next step, if not - calls again 3rd-4th steps

  5. Client calls /completion/ endpoint so that no more new media files can be uploaded and the identification can be visible in BO. Additional registries are processed in this step

  6. VerifID services processes the data and puts identification details in Ondato Back-office

  7. Client double checks the identification details and cross-checks the identification

  8. When identification details are updated client gets webhook HTTPS message to his provided URL address

\n\nThis API is available in the following environments:\n\n\n\n***Note that in the sandbox environment all of the identification data is removed after 24 hours since the identification was started**\n\n* * *\n\n

WEBHOOKS

\n\nWebhooks are user-defined HTTP callbacks. They are usually triggered by some event.\n\nOndato provides webhooks to alert you of changes in the status of customer identification. These are `POST` requests to your server that are sent as soon as an event occurs. The body of the request contains details of the identification status.\n\nAll identification status changes trigger webhook notifications, even for those that complete instantly. If the document data will be changed manually from BO then webhook notification will also be triggered.\n\nWebhook endpoints can be registered through the Ondato BO or VeridId API. To help you diagnose or to understand webhook issues, a log of your webhook requests is also available under your dashboard’s Webhook Logs and through the API endpoint.\n\nUpon receiving a webhook notification, you should acknowledge success by responding with an `HTTP 200` success status code. Otherwise, we will attempt to resend the notification up to 3 times every 10 minutes.\n\nThe following events will trigger a message to registered webhooks:\n\n\n\nEach webhook URL is associated with a unique identification ID. When providing the URL you need to specify the place where our services will put the identification ID.\n\nFor example:\n\n[https://mycompany.com/ondato_webhook/\\`{identification-id}\\`/receive](https://mycompany.com/ondato_webhook/`{identification-id}`/receive)\n\n[https://demo.com/ondato_webhook?identification=\\`{identification-id}\\`](https://demo.com/ondato_webhook?identification=`{identification-id}`)\n\n[https://demo.com/ondato_webhook?status=xxx&identification=\\`{identification-id}\\`¶m=abc](https://demo.com/ondato_webhook?status=xxx&identification=`{identification-id}`¶m=abc)\n\nThen the {identification-id} will be replaced with a unique identification ID from our API services:\n\n[https://demo.com/ondato_webhook/\\`12345e24a362476cbc263872bd8ea254\\`/receive](https://demo.com/ondato_webhook/`12345e24a362476cbc263872bd8ea254`/receive)\n\n[https://demo.com/ondato_webhook?identification=\\`12345e24a362476cbc263872bd8ea254\\`](https://demo.com/ondato_webhook?identification=`12345e24a362476cbc263872bd8ea254`)\n\n[https://demo.com/ondato_webhook?status=xxx&identification=\\`12345e24a362476cbc263872bd8ea254\\`¶m=abc](https://demo.com/ondato_webhook?status=xxx&identification=`12345e24a362476cbc263872bd8ea254`¶m=abc)\n\nFor security reasons webhooks sent to your application will be signed using unique per application generated signature. Verifying the request signature on your server prevents attackers from imitating valid webhooks. The signature will be stored in a `X-API-KEY` header.\n\nExample response body:\n\nHeader: \n`Content-Type: application/json` \n`X-API-KEY: 6CC494A4-1BDE-4093-A0BD-8756B0BFDECA`\n\nBody:\n\n```\n{\n \"Id\":\"0BA5FDC0-A505-4CCC-CD3B-08D6FEFE2503\",\n \"RequestStatus\":\"AUTO_FINISH\",\n \"IsCrossChecked\":true,\n \"RejectionReason\":null,\n \"Event\":\"PROCESSED\"\n}\n\n```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6997242","collectionId":"2be54b91-0dc2-4de8-bf6c-bf0e1d67cfd1","publishedId":"S1TZwaZe","public":true,"publicUrl":"https://documenter-api.postman.tech/view/6997242/S1TZwaZe","privateUrl":"https://go.postman.co/documentation/6997242-2be54b91-0dc2-4de8-bf6c-bf0e1d67cfd1","customColor":{"top-bar":"244D50","right-sidebar":"244D50","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-08-04T13:41:46.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/cf189c258a9efc3c9a37ebf08a4146d6d8a23e3be7b94e5accdfab8655fef64e","favicon":"https://res.cloudinary.com/postman/image/upload/v1581257273/team/mfybvavx8bphoovl5f4h.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/S1TZwaZe"}