{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8dbea672-09a6-444e-ba59-3ade1d5ce7ea","name":"Identity Verification API","description":"**This collection is intended to integrate Ondato Identification process to your web application.**\n\n# Base Url\n\n*   Production [`https://kycapi.ondato.com`](https://kycapi.ondato.com)\n*   Sandbox [`https://sandbox-kycapi.ondato.com`](https://sandbox-kycapi.ondato.com)\n    \n\n# API Keys\n\nYou'll need your API keys, so contact \\[[info@ondato.com](mailto:info@ondato.com)\\](mailto:[info@ondato.com](mailto:info@ondato.com)?subject=get API key) if you don't have them.\n\nThink of your key like a password:\n\n*   Store it securely\n*   Don't share it with anyone outside of your organization\n*   Don't put it in any code on your website or in a Url that someone could find\n    \n\n# Setup\n\nAll requests needs your api key, so when you have it replace placeholder `YOUR-API-KEY` with it.  \nIn `Deprecated` methods api key passed as body parameter in `POST` methods, in `Other` methods api key passed as header `x-api-key`.\n\n# Available languages\n\n*   sq - Albanian\n*   bg - Bulgarian\n*   ca - Catalan\n*   cs - Czech\n*   en - English\n*   et - Estonian\n*   fr - French\n*   de - German\n*   lv - Latvian\n*   lt - Lithuanian\n*   pl - Polish\n*   pb - Portuguese (Brazil)\n*   ru - Russian\n*   es - Spanish\n*   uk - Ukrainian\n*   vi - Vietnamese\n*   nl - Dutch\n    \n\n# Swagger\n\n[Identifications API](https://sandbox-kycapi.ondato.com/index.html)\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\nTo 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<ul><li><p><code>PROCESSED</code> - Webhook is triggered when new identification is processed</p></li><li><p><code>CROSS_CHECKED</code> - Webhook is triggered when identification is cross checked / approved in Ondato Portal</p></li><li><p><code>UPDATED</code> - Webhook is triggered when document data is updated in Ondato Portal</p></li><li><p><code>REJECTED</code> - Webhook is triggered when identification is rejected in Ondato Portal</p></li></ul>\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 request\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":"517349","collectionId":"8dbea672-09a6-444e-ba59-3ade1d5ce7ea","publishedId":"S1TVXxnL","public":true,"publicUrl":"https://documenter-api.postman.tech/view/517349/S1TVXxnL","privateUrl":"https://go.postman.co/documentation/517349-8dbea672-09a6-444e-ba59-3ade1d5ce7ea","customColor":{"top-bar":"244D50","right-sidebar":"244D50","highlight":"FF5A28"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2020-08-04T13:48:02.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"IDV Documentation","id":"af5e5bcc-6c85-45cc-8041-ca66ddbd8685","owner":"517349","values":[{"key":"baseUrl","value":"https://sandbox-kycapi.ondato.com","enabled":true},{"key":"apiKey","value":"YOUR-API-KEY","enabled":true}],"published":true}],"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"},{"label":"IDV Documentation","value":"517349-af5e5bcc-6c85-45cc-8041-ca66ddbd8685"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/S1TVXxnL"}