IDnow - The Platform for Identity Proofing.
\nNOTE: This documentation only applies to our product IDnow AutoIdent.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"19213585","collectionId":"26b43e83-c1be-469d-912d-38f0542801d1","publishedId":"UzBmPTs7","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2026-02-10T20:23:45.000Z"},"item":[{"name":"Introduction","item":[],"id":"30644ee2-81a4-4687-afed-ecc432cb6247","description":"IDnow offers its identity verification solutions via a standardized programmatic interface to its clients. We offer a RESTful API that is based on HTTP requests and JSON responses. This documentation provides you with an overview of the API endpoints and information on implementing our services in your own IT infrastructure.
\nFor getting to know the IDnow API endpoints and result data, we recommend using the Postman tool. It helps with running and debugging your API requests. IDnow provides its own Postman Collection of API requests which you can simply access by clicking Run in Postman above.
This collection is also the basis of this documentation and you will find every endpoint described here being readily available in our collection.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"904bc598-bb74-428b-8896-99d528266b0a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"63dafd55-35a8-43e7-985f-f90cf749daee"}}],"_postman_id":"30644ee2-81a4-4687-afed-ecc432cb6247"},{"name":"Product Overview","item":[{"name":"IDnow AutoIdent","item":[],"id":"9a0d0622-2e74-4bfa-ae24-68d7b9b77874","description":"IDnow AutoIdent is an automated digital identity verification product that is used to verify the identity a person and establish ownership and authenticity of their ID document.
\nThe process includes the following steps:
\nDetermination of the type of document used (e.g. Passport, ID-card, Driver's license)
\nDetermination of the version of the document (e.g. German passport)
\nRetrieval of the data from the document
\nBiometric selfie comparison
\nLiveness detection
\nVerification of the authenticity of the document used during the identification process
\nIDnow AutoIdent offers mobile SDKs for integration into customer's apps, native mobile Apps for iOS and Android that can be used directly from the app stores, and a React Native plugin for cross-platform support. IDnow AutoIdent also offers a web browser solution which can be used as a standalone product or integrated into the customer's website using an iFrame or in a WebView.
\nIDnow AutoIdent offers the following
\nSDKs (documentation available at the below github links)
\nNative Mobile Apps
\nReact Native plugin and documentation available at the below NPM link
\nThis document is targeted at developers of third party companies who want to integrate the IDnow verification service into their own applications.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"46995d6b-818e-41fc-950d-c8dec178f68b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"9259cf2e-ab56-442e-9f43-10d22c924504"}}],"_postman_id":"1ef1a40b-c1ac-4b29-8ea8-e604a8215d20"},{"name":"Glossary","item":[],"id":"873292db-816b-4508-8122-7648ad45a0b2","description":"In this section, we would like to introduce our ubiquitous language used throughout this documentation for a better understanding of the entities you will be using and interacting with when requesting our API services and when talking to our teams:
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"aed9f610-ff04-4b12-a830-7a989af3d9f5"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"62a39693-e96b-41f5-b9bd-6cd1dfbb1fde"}}],"_postman_id":"873292db-816b-4508-8122-7648ad45a0b2"},{"name":"Getting Started","item":[{"name":"Ident Lifecycle","item":[],"id":"594a1630-5955-454b-94fd-874849ea7e83","description":"Ident Lifecycle
\nThe Ident lifecycle starts with the creation of an Ident request. Ident requests can be created by you via the API using user data that you have captured during your initial user registration process. Users then perform the identification process using our native app, SDK or web app.
\nOnce an identification is completed by the user in the app, it can go through different flows depending on how your account is setup. The default or standard flow is that the Ident is automatically analysed (called AutoReview) by our AI system and there is an outcome. However, in cases where AI flags errors or is unable to conclusively determine the outcome of an Ident, it sends the Ident to an IDnow agent for a manual review, and after review, the final outcome will be available.
The following diagram shows the Ident Lifecycle with the option AutoReview enabled. This is the case where a customer wants only those idents to be reviewed by an agent which have not been automatically analysed by the system. The AI system performs a number of checks and validations and if it is not confident of the result, the ident is sent to a human agent for review.
Once this entire process is complete, you will be able to retrieve the final result of the identification. You will also receive webhooks at various stages of the process as indicated in the diagram.
\nIt is not possible to retrieve data for an Ident which has not yet been started by the user in the app. These 'not completed' Idents stay in the created state. Data or result retrieval requests via the API, for such cases, will result in an error, as the Ident is not finished. API calls are discussed later in the documentation.
The following diagram shows the Ident Lifecycle with the AutoReview option disabled. This is the case where a customer wants all the idents to be reviewed manually by an agent:
IdentIDs can be reused as long as they do not have a Finished status, i.e the Ident has one of these final outcomes - Success, Success_Data_Changed and Fraud_Suspicion_Confirmed)
Idents that are in the Canceled or Aborted states can be reused for the same user to start another attempt.
If an IdentID is Canceled by the agent or if it is Aborted because the user drops out during the identification process in the app due to any reason (network issues, app issues, user intended to drop out), then the same IdentID should be reused by the user again. Therefore, it is important that no new IdentID is generated for the same user identification. Always ensure to use the same IdentID for the same user. Multiple IdentIDs for the same user will cause problems with the product in the longer run.
If an IdentID is being reviewed by the agent/supervisor then the user cannot use the same IdentID to start another attempt in the app. Users should not be allowed to start a new idnentification process when an agent/supervisor is reviewing the existing identification request of the user.
\nIn some cases, it may happen that the FINAL webhook results are changed by IDnow later on. These are rare cases, for instance, if an agent/supervisor made a mistake in identifying a user and marked it as a Fraud_Suspicion_Confirmed, but then the customer reported it and asked for it to be marked as Success, then in such cases, supervisors can review the Ident again and change its status. These rare cases should be considered during the integration.
Before sending any request, the value for the API Key has to be set in your environment. With the API Key set, the first request must be to authenticate and obtain a JWT. The JWT is necessary for accessing the API with any subsequent requests.
\nRequest: POST Company Login\n\nAdd this value to your global variable LOGIN-TOKEN. It will then be automatically used in the header as the value for the parameter: X-API-LOGIN-TOKEN for every following request you send.
The JWT will be invalidated on the serverside if it has not been used for at least one hour. If you request our API with an expired token, your requests will get a 401 Unauthorized error and you have to authenticate again. Using a wrong Customer/Shortname also results in an 401 Unauthorized error.
Please make sure that all data is sent as UTF-8 encoded JSON. This is especially important because the encoding will influence the calculation of the security token. The expected JSON structure is flat.
\n","_postman_id":"7c05b4e6-7ae4-4f52-8b30-1afc08c1ad97"},{"name":"Protocol and Port","item":[],"id":"bf3e5583-bab4-4a1f-be95-f8f11f499f11","description":"To ensure that all parameters are encrypted, all requests to the IDnow server must be performed using HTTPS! HTTP is not allowed. The port for all requests is: 443.
\n","_postman_id":"bf3e5583-bab4-4a1f-be95-f8f11f499f11"},{"name":"Linking a Transaction Number to an existing User","item":[],"id":"e0d6baff-4cbf-4b1e-ab1a-daf62bd6d178","description":"Let's assume there is an existing user with complete data in your database whose identity you need to verify. IDnow allows for adding a unique transactionnumber (recommended) of your choice to every Ident creation request. You can use this number to associate the Ident e.g. with the corresponding entity in your system. When retrieving an Ident, this number will be provided back to you as the transactionnumber in the JSON body.
A Transaction number is a unique reference number which you generate on your end. This is your internal reference number for an identification request. It is required that the Transaction number generated by your system meets these requirements:
\n[a-z][A-Z][0-9][_-] to be compatible with the IDnow systemThe transaction number is case-insensitive and is used in the URL of the API Request.
\nAdditionally, the IDnow system (internally) assigns each identification another ID which is called IdentID and is also visible for the user. It takes the form of ABC-DEFGH.
Note: Transaction numbers that you generate are unique to a shortname. The same Transaction number cannot be reused for the same shortname. In case a Transaction number was deleted, the same Transaction number cannot be reused to create another Ident request.
Customers starting to integrate AutoIdent will receive guidance from our team.
\nIDnow's team will setup the prerequisites needed by the customer.
\nIDnow will provide the environment (test account), shortname and API key
\nCustomers will need to setup Webhook listeners in order to receive results and setup redirect URLs for post processing.
\nIDnow offers mobile SDKs for AutoIdent which can be used to integrate the AutoIdent solution into customer's mobile apps. IDnow also offers readily available native mobile apps via Google Play and Apple App Store which can be used by users to execute the identity verification process. IDnow also offers a React Native plugin for cross-platform support and also a web browser solution which can be integrated into a customer's website.
\nThe picture below explains how a customer can integrate the IDnow platform with their system.
\nBefore you can send requests, a proper environment has to be set up. An environment holds parameters for setting your company name, API Key, login-token and the gateway host for your requests. The parameters in the API Request URL are placeholders. The applicable values for the placeholders are automatically used in your requests.
\nThe structure of our API Request URL looks like this:
\n{GATEWAYHOST}/api/v1/{CUSTOMER}/\n\nThe following table shows those parameters with demo data. The IDnow collection holds global variables for authentication and provides two environments, one for testing and one for production calls. With our demo data and test environment you are able to make example requests from the start, without having to write any code or use your real data (except your API Key).
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"21f186ba-5a80-45c3-a03f-04d56a3ad3cd"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"0dcf847a-dc0f-4fff-a573-b8b1955d2127"}}],"_postman_id":"176a08e8-b211-46f8-a357-4676a51a70cc"},{"name":"IDnow Onboarding","item":[{"name":"General User Onboarding","item":[],"id":"534e94b2-0b2e-4885-b5ad-aa833b080c73","description":"Please note that IDnow offers different data centers for the different countries that our clients come from, as well as several subdomains for the different services we offer.
\nNote: Only use the CH servers if you are in Switzerland. Use the AE servers if you are in the UAE. For all other countries, use the DE servers.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"e475a0e1-a6a6-4a2a-8ec2-8991d9c9e718"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"3acb50e5-10aa-4b7e-9929-80291e3e4edc"}}],"_postman_id":"534e94b2-0b2e-4885-b5ad-aa833b080c73"},{"name":"Production Gateway","item":[],"id":"d0cdef7d-7512-4ced-82b1-eb187888d453","description":"This interface provides endpoints for exchanging customer data and allows for retrieving information of an Ident in its various statuses throughout its lifecycle.
\nNote: Only use the CH servers if you are in Switzerland. Use the AE servers if you are in the UAE. For all other countries, use the DE servers.
\nPoint the implementation of your production environment to the addresses in the following table:
\nIf white labeling is used, i.e. if you only use our SDK and build your own app around it, the host depends on the setup of the company. You will be provided the URL during account setup.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"be9ceaf3-fb55-4ddc-8767-e134ef661e17"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"80963b5f-c466-420b-84f3-a71afcf3e087"}}],"_postman_id":"d0cdef7d-7512-4ced-82b1-eb187888d453"},{"name":"Test Gateway","item":[],"id":"9d9c9e1c-d6e1-45f9-8368-1c00dced0f29","description":"Use this interface for testing purposes. The IDnow Postman collection comes with a testing environment and sample requests.
\nNote: Only use the CH servers if you are in Switzerland. Use the AE servers if you are in the UAE. For all other countries, use the DE servers.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"29ab7732-4ac2-4679-a509-503a787ad80d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"497104bb-182a-4ffa-bc7f-d1a2734d06a7"}}],"_postman_id":"9d9c9e1c-d6e1-45f9-8368-1c00dced0f29"},{"name":"Login, Creating Idents & Retrieving Ident data","item":[{"name":"Company Login","event":[{"listen":"test","script":{"id":"92bf58b3-02dc-4b75-b5e3-23910e469a23","exec":["var jsonData = pm.response.json();\r","pm.globals.set(\"LOGIN-TOKEN\", jsonData.authToken);\r",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"91a72519-2a1d-41e6-912d-ff61f3e1e143","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"(REQUIRED) The media type
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"apiKey\": \"\"\n}"},"url":"/api/v1//login","description":"The API endpoint allows users to get the JSON Web Token or AUTH token which can be used in subsequent API requests to get access to the information. The user provides the value of API key and receives AUTH token which is necessary for login into API service.
\n","urlObject":{"path":["api","v1","","login"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"f3c76440-cbfa-473d-9c49-32e8f5df4ba3","name":"Company Login 200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"**(REQUIRED)** The media type","type":"text"}],"body":{"mode":"raw","raw":"{\n \"apiKey\": \"\"\n}"},"url":"/api/v1//login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin,Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"334"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Thu, 06 Jun 2019 06:30:02 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"authToken\":\"iYXVkIjoiZGUuaWRub3cuYXBwbGljYXRpb24iLCJleHAiOjE1NTk4MDYyMDIsImp0aSI6Im9qOVJxZHpFaHJKdjI2d0tSWWR5vdy5nCJpYXQiOjE1NTk4MDI2MDIsIm5iZiI6MTU1OTgwMjQ4Miwic3ViIjoiZGVtb3NlY3VyaXR5ZmVhdHVyZXMi0eXBlIQ09NUEFOWSIsInBlcm1pc3Npb25zIjoiQUxMIn0.s0nI00Uz-E6Gk4crFuzFHZT9dNu7sspUzfbtvXRTzwnQ9DN3gntTwUkKAJBGlyILdocAwj30BoG7J7L0rWTOyg\"\n}"},{"id":"6a0549dc-73de-42be-8e1e-33f37e66edb4","name":"Company Login 500","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"raw","raw":"{\n \"apiKey\":\"\"\n}"},"url":"/api/v1//login"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"161"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Wed, 05 Jun 2019 09:17:53 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"cause\": \"INTERNAL_SERVER_ERROR\",\n \"errorType\": null,\n \"id\": \"61262858\",\n \"key\": null,\n \"message\": \"An internal server error has occured\",\n \"translationKey\": null\n }\n ]\n}"}],"_postman_id":"91a72519-2a1d-41e6-912d-ff61f3e1e143"},{"name":"Create Ident","event":[{"listen":"prerequest","script":{"id":"8d267711-1d92-471d-9f52-5ac12704d602","exec":[""],"type":"text/javascript","packages":{}}}],"id":"f9b482e3-72d3-475c-92ce-dd7945144a12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"(REQUIRED) Your private Auth Token
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(REQUIRED) The media type
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"birthday\":\"1987-05-23\",\n \"birthplace\":\"London\",\n \"custom1\": \"Eg. Employer name\",\n \"custom2\": \"Eg. Job Position \",\n \"custom3\": \"Eg. Insurance number\",\n \"custom4\":\"or store any data strings\",\n \"custom5\":\"you like.\",\n \"email\":\"hello@democompany.org\",\n \"firstname\":\"Erika\",\n \"gender\":\"FEMALE\",\n \"lastname\":\"Musterman\",\n \"mobilephone\":\"+49175310960\",\n \"nationality\":\"DE\",\n \"zipcode\":\"80469\",\n \"country\":\"DE\",\n \"city\":\"Munich\",\n \"street\":\"High Street\",\n \"streetnumber\":\"100\"\n}"},"url":"/api/v1//identifications//start","description":"This endpoint enables users to create an Ident request. To successfully create a request, users must provide a transaction number. The transaction number is a unique alphanumeric string that users can define of their choice during the creation of the Ident ID. Each transaction number is distinct and is linked to a single Ident ID, ensuring a one-to-one association between the transaction and the Ident request.
\n","urlObject":{"path":["api","v1","","identifications","","start"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"587c4975-b491-44b5-8bab-099fead3a2cb","name":"Create Demo Ident 201","originalRequest":{"method":"POST","header":[{"description":"**(REQUIRED)** Your private Auth Token","key":"X-API-LOGIN-TOKEN","type":"text","value":"{{LOGIN-TOKEN}}"},{"description":"**(REQUIRED)** The media type","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birthday\":\"1987-05-23\",\n \"birthplace\":\"London\",\n \"city\":\"London\",\n \"country\":\"GB\",\n \"custom1\": \"Eg. Employer name\",\n \"custom2\": \"Eg. Job Position \",\n \"custom3\": \"Eg. Insurance number\",\n \"custom4\":\"or store any data strings\",\n \"custom5\":\"you like.\",\n \"email\":\"hello@democompany.org\",\n \"firstname\":\"Olivia\",\n \"gender\":\"FEMALE\",\n \"lastname\":\"Jones\",\n \"mobilephone\":\"+441789012345\",\n \"nationality\":\"GB\",\n \"street\":\"Baker Street\",\n \"zipcode\":\"W1U\"\n}"},"url":"/api/v1//identifications/demo-transactionxxnbrxyz123/start"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin,Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"38"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Thu, 06 Jun 2019 09:12:17 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"TST-FXWFG\"\n}"},{"id":"9e2fa7ec-0af9-4ddd-a16e-a66f44670eb1","name":"Create Demo Ident 401","originalRequest":{"method":"POST","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"birthday\":\"1987-05-23\",\n \"birthplace\":\"London\",\n \"city\":\"London\",\n \"country\":\"GB\",\n \"custom1\":\"X-AUTOTEST-HAPPYPATH\",\n \"custom2\":\"Custom fields\",\n \"custom3\":\"can set testbot scenarios\",\n \"custom4\":\"or store any data strings\",\n \"custom5\":\"you like.\",\n \"email\":\"hello@democompany.org\",\n \"firstname\":\"Olivia\",\n \"gender\":\"FEMALE\",\n \"lastname\":\"Jones\",\n \"mobilephone\":\"+441789012345\",\n \"nationality\":\"GB\",\n \"street\":\"Baker Street\",\n \"zipcode\":\"W1U\"\n}"},"url":"/api/v1//identifications/demo-transactionxxnbr100/start"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Vary","value":"Origin"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Wed, 05 Jun 2019 07:59:58 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f9b482e3-72d3-475c-92ce-dd7945144a12"},{"name":"Ident","id":"05988aa7-1ad1-4cc9-a0f2-98662e0ed34d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"(REQUIRED) Your private Auth Token
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(REQUIRED) The media type
\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/api/v1//identifications/ OR ","description":"The API allows the user to retrieve an ident, which was created earlier. The transaction number associated with the ident ID must be passed in the request to get demo ident because every ident number is identified by its unique transaction number.
\n","urlObject":{"path":["api","v1","","identifications"," OR "],"host":[""],"query":[],"variable":[]}},"response":[{"id":"e6715d37-87e5-46f6-94b0-b60c671f4eeb","name":"Get Demo Ident 200","originalRequest":{"method":"GET","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"**(REQUIRED)** Your private Auth Token","type":"text"},{"key":"Content-Type","value":"application/json","description":"**(REQUIRED)** The media type","type":"text"}],"url":"/api/v1//identifications/TST-SMGDA/bindingKey"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin,Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"683"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Thu, 06 Jun 2019 07:41:01 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"identificationprocess\": {\n \"result\": \"CANCELED\",\n \"reason\": \"USER_CANCELLATION\",\n \"companyid\": \"demosecurityfeatures\",\n \"filename\": \"demo-transactionxxnbr2.zip\",\n \"identificationtime\": \"2019-06-06T09:34:10+02:00\",\n \"id\": \"TST-SMGDA\",\n \"href\": \"/api/v1/demosecurityfeatures/identifications/demo-transactionxxnbr2.zip\",\n \"type\": \"APP\",\n \"transactionnumber\": \"demo-transactionxxnbr2\"\n },\n \"customdata\": {\n \"custom3\": \"can set testbot scenarios\",\n \"custom4\": \"or store any data strings\",\n \"custom1\": \"\",\n \"custom2\": \"Custom fields\",\n \"custom5\": \"you like.\"\n },\n \"contactdata\": {\n \"mobilephone\": \"+441789012345\",\n \"email\": \"hello@democompany.org\"\n },\n \"userdata\": {\n \"birthday\": {\n \"status\": \"CHANGE\",\n \"value\": \"1981-10-17\",\n \"original\": \"1987-05-23\"\n },\n \"firstname\": {\n \"status\": \"CHANGE\",\n \"value\": \"SAMUEL\",\n \"original\": \"OLIVIA\"\n },\n \"address\": {\n \"zipcode\": {\n \"status\": \"MATCH\",\n \"value\": \"W1U\"\n },\n \"country\": {\n \"status\": \"MATCH\",\n \"value\": \"GB\"\n },\n \"city\": {\n \"status\": \"CHANGE\",\n \"value\": \"MUNICH\",\n \"original\": \"LONDON\"\n },\n \"street\": {\n \"status\": \"CHANGE\",\n \"value\": \"PRINZREGSTR.\",\n \"original\": \"BAKER STREET\"\n }\n },\n \"birthplace\": {\n \"status\": \"CHANGE\",\n \"value\": \"UTOPIA CITY\",\n \"original\": \"LONDON\"\n },\n \"nationality\": {\n \"status\": \"CHANGE\",\n \"value\": \"AQ\",\n \"original\": \"GB\"\n },\n \"gender\": {\n \"status\": \"CHANGE\",\n \"value\": \"MALE\",\n \"original\": \"FEMALE\"\n },\n \"identlanguage\": {\n \"status\": \"MATCH\",\n \"value\": \"en\"\n },\n \"lastname\": {\n \"status\": \"CHANGE\",\n \"value\": \"JOHNSON\",\n \"original\": \"JONES\"\n }\n },\n \"identificationdocument\": {\n \"country\": {\n \"status\": \"NEW\",\n \"value\": \"AQ\"\n },\n \"number\": {\n \"status\": \"NEW\",\n \"value\": \"LGPJ11235\"\n },\n \"type\": {\n \"status\": \"NEW\",\n \"value\": \"IDCARD\"\n },\n \"validuntil\": {\n \"status\": \"NEW\",\n \"value\": \"2024-10-16\"\n }\n },\n \"attachments\": {\n \"pdf\": \"demo-transactionxxnbr2.pdf\",\n \"xml\": \"demo-transactionxxnbr2.xml\"\n }\n}"},{"id":"0af1c165-65f8-47d1-949b-a0d13a370b31","name":"Get Demo Ident 401","originalRequest":{"method":"GET","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}"},{"key":"Content-Type","value":"application/json"}],"url":"/api/v1/{{COMPANYID}}/identifications/TST-RNWSA/bindingKey"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"125"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Wed, 05 Jun 2019 08:01:31 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"cause\": \"INVALID_LOGIN_TOKEN\",\n \"errorType\": null,\n \"id\": \"83243697\",\n \"key\": null,\n \"message\": null,\n \"translationKey\": null\n }\n ]\n}"},{"id":"748f0a72-820e-48d1-a602-8ad68dbb7543","name":"Get Demo Ident 404","originalRequest":{"method":"GET","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}"},{"key":"Content-Type","value":"application/json"}],"url":"/api/v1//identifications/TST-RNWSA/bindingKey"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"202"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Wed, 05 Jun 2019 12:17:42 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"cause\": \"OBJECT_NOT_FOUND\",\n \"errorType\": null,\n \"id\": \"54751601\",\n \"key\": \"Ident TST-RNWSA - No identification request found matching the provided parameters\",\n \"message\": null,\n \"translationKey\": null\n }\n ]\n}"}],"_postman_id":"05988aa7-1ad1-4cc9-a0f2-98662e0ed34d"},{"name":"Get Binding Key","id":"1a70a378-d687-447b-91f5-be472d649bb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"(REQUIRED) Your private Auth Token
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(REQUIRED) The media type
\n","type":"text"}],"url":"/api/v1//identifications//bindingKey","description":"Retrieves the Binding Key for an Ident. A 'Binding Key' is a unique token that can be sent by customers when initializing the AutoIdent SDK. It can be used for device binding use cases and helps establish a correlation between a user's verified identity and their mobile device on which the identification was performed. It is particularly useful for device authentication and re-authentication scenarios when users change devices.
\nBindingKey for a completed identification can be fetched via this API endpoint and can then be compared with the one that was originally generated and sent during SDK initialization.
\nThis is an optional feature which needs to be enabled for your account. Please contact your technical contact at IDnow for enabling this feature.
\nFor information on sending the BindingKey via the SDK, please see our Integration Guide on github - bindingKey iOS github, bindingKey Android github
\n","urlObject":{"path":["api","v1","","identifications","","bindingKey"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"d1dba7ba-a131-4bf6-9ab1-f011389ef34c","name":"Get Binding Key 200 OK","originalRequest":{"method":"GET","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"**(REQUIRED)** Your private Auth Token","type":"text"},{"key":"Content-Type","value":"application/json","description":"**(REQUIRED)** The media type","type":"text"}],"url":"/api/v1//identifications//bindingKey"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin,Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-security-policy","value":"script-src 'self'; style-src 'self' 'unsafe-inline'; base-uri 'none'; form-action 'self'; object-src 'none'; default-src 'self'; frame-ancestors 'self'"},{"key":"date","value":"Fri, 11 Jul 2025 13:38:51 GMT"},{"key":"content-length","value":"824"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"strict-transport-security","value":"max-age=16000000;"}],"cookie":[],"responseTime":null,"body":"{\n \"bindingKey\": \"eyJ4NWMiOlsiTUlJQnp6Q0NBWFNnQXdJQkFnSVFWVG5GZzNXeFEwMk94enRuWmJxUmxEQUtCZ2dxaGtqT1BRUURBakJsTVRVd013WURWUVFERXl4M1lXeHNaWFF0Y0hKbGNISnZaQzB3T21SbExtbGtibTkzTG5kaGJHeGxkQzVyWlhsekxsSnZiM1JEUVRFT01Bd0dBMVVFQ2hNRlNVUk9iM2N4RHpBTkJnTlZCQWNUQmsxMWJtbGphREVMTUFrR0ExVUVCaE1DUkVVd0hoY05NalV3TmpFM01USXpPREF5V2hjTk16VXdOakUzTWpJMU1EQXlXakJ0TVVrd1J3WURWUVFEREVBMlkyRmlNVGMyT1RJd056WTBPRGM0WW1KbE5XSTFaVEkwWldaak56WTBOVGxoWVRRM016QmtNbUUxWmpRd01qZG1Zek16TmpZeU9XVTVPVE0wTTJSak1STXdFUVlEVlFRS0RBcEpSRzV2ZHlCSGJXSklNUXN3Q1FZRFZRUUdFd0pFUlRCWk1CTUdCeXFHU000OUFnRUdDQ3FHU000OUF3RUhBMElBQkxPNG5SYXQvUmc0WlZsUjZyaFpmYlJ3OWo5S1EvN3p1NWtacGhyMEdESWhFeWhqUmhmdnlMUGpNWGJlbEtxdExPR0I5YTRrK2JjVmFFdi83QVdoUmFBd0NnWUlLb1pJemowRUF3SURTUUF3UmdJaEFLR2pZUHVteVRzaFNRcHlLZzNrb25yQ25kU0kzMnh2Wk5XMURUNER6SjJ5QWlFQW5WWVQ3Y2MvTlYxRFpEa0t2N2hqRVNWOU9GSXpsYlVDMnlsYlp3cXdzU289Il0sImtpZCI6ImRlLmlkbm93LndhbGxldC5rZXlzLkRldmljZSIsInR5cCI6IkpXVCIsImFsZyI6IkVTMjU2In0.eyJpYXQiOjE3NTEyOTcxODF9.EpRTLua62Kmm1VCnAysiBfANKYmn2-BfC-4Ru5Zmv_lv23oKntqgyqllqXpCOPsaoeEpjRdfs26ab72Q37j9sg\"\n}"},{"id":"5010f85b-11d4-4279-add0-8021e0312f1e","name":"Get Binding Key 404","originalRequest":{"method":"GET","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"**(REQUIRED)** Your private Auth Token","type":"text"},{"key":"Content-Type","value":"application/json","description":"**(REQUIRED)** The media type","type":"text"}],"url":"/api/v1//identifications//bindingKey"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-origin","value":"*"},{"key":"date","value":"Fri, 11 Jul 2025 13:36:25 GMT"},{"key":"content-length","value":"209"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"strict-transport-security","value":"max-age=16000000;"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"cause\": \"OBJECT_NOT_FOUND\",\n \"errorType\": null,\n \"id\": \"37165048\",\n \"key\": \"id\",\n \"message\": \"No binding key associated with the specified identification with internalToken: TS2-AEGRU\",\n \"translationKey\": null\n }\n ]\n}"},{"id":"8f611130-1a7a-4379-9dde-be8da5481521","name":"Get Demo Ident 401","originalRequest":{"method":"GET","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}"},{"key":"Content-Type","value":"application/json"}],"url":"/api/v1/{{COMPANYID}}/identifications/demo-transactionxxnbr100"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"125"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Wed, 05 Jun 2019 08:01:31 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"cause\": \"INVALID_LOGIN_TOKEN\",\n \"errorType\": null,\n \"id\": \"83243697\",\n \"key\": null,\n \"message\": null,\n \"translationKey\": null\n }\n ]\n}"}],"_postman_id":"1a70a378-d687-447b-91f5-be472d649bb1"}],"id":"88313faf-f230-4c7f-9456-1d962a73dc88","description":"This section details how Ident requests can be created and retrieved.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"d8854f96-a302-4c24-a0e7-bf6388995e38"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"be67fefe-4fd3-4ab0-bbc1-2713ea3c6f8f"}}],"_postman_id":"88313faf-f230-4c7f-9456-1d962a73dc88"},{"name":"Redirecting the User to IDnow's Ident Verification Flow","item":[],"id":"dd960ad1-f3a6-4d4e-89b4-6893b460e7ae","description":"After creating an Ident request via the API, you can redirect the user to the Ident verification process of IDnow using the below URLs.
\nThere are two ways to build the link. Both links are equivalent. The identification process can also be embedded as an iframe or opened as a popup.
\nNote: Only use the CH servers if you are in Switzerland. Use the AE servers if you are in the UAE. For all other countries, use the DE servers.
\nThere are two ways to build the link:
\nLong link using shortname and transactionnumber:
Short link using IdentID as returned in result:
When this feature is activated for your account, the user can be forwarded to a custom URL on your web server after the user has completed the ident verification process. Separate redirection URLs can be configured depending on whether the user completes the verification flow in the app/web app (successURL) or aborts it (failureURL). Success and Failure URLs can be configured separately for each OS (iOS.Success, iOS.Failure or Android.Success and Android.Failure) and separately for our Web app as well.
The redirect URLs support the variable ${transactionnumber} so that you can receive it and match the redirect call to your internal transaction number.
To configure and activate the redirection feature, please contact your technical account manager at IDnow.
\nExample:
\nhttps://www.yourcompany.com/ident-success?q=${transactionnumber}\n\nIDnow supports embedding the AutoIdent Web app via an iframe or popup and can also be embedded into a WebView within a native Android or iOS app. For the following embedding options, only the long link as described earlier is supported. It is important to note that the url should have IdentID instead of transactionnumber.
\nBefore loading the iframe, popup or WebView, make sure the ident has been created and ident request data has been sent to IDnow.
\nFor iframes, we recommend using the 'fullscreen' mode and the recommended minimum width (600px) and height (800px) for the page to be displayed properly. Please also ensure that the camera permission has been specifically allowed for the webview:
\n<iframe src=\"https://go.idnow.de/<customer>/identifications/<IdentID>/identification/start\" style=\"width: 100vw; height: 800px\" allow=\"camera *; microphone *\" allowfullscreen=\"\"></iframe>\n\nIt is also possible to open the identification in a popup. In JavaScript, use the following command:
\nwindow.open(\"https://go.idnow.de/<customer>/identifications/<IdentID>/identification/start\", \"_blank\", \"width=600,height=800,left=50,top=50,location=no,menubar=no,resizable=yes,scrollbars=yes,status=no,titlebar=no,toolbar=no\");\n\nThe verification process can also be integrated in your Android and iPhone applications.
\nFor more details, please visit us on Github:
\nAndroid SDK - https://github.com/idnow/de.idnow.android.sdk
\nThis section details creating an authenticated session, creating Ident requests and bringing users into the identification flow and redirecting users after they complete the identification process.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"7a9ecd4b-f301-44b4-bb9a-77f66749e90e"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"2f0858ba-4c51-4266-ad3f-da0573450867"}}],"_postman_id":"6ae1f65c-f564-4787-be04-8a9e61ccd8dd"},{"name":"AutoIdent with QES / eSign","item":[{"name":"Document Definition","item":[{"name":"Fields of a Document Definition","item":[],"id":"eaea880a-09fc-448c-aa38-d035fc3db709","description":"","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b72014e7-db3a-476d-92a7-b60170722b61"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"0e6c57c3-bbb4-44e8-ba32-d770f7911226"}}],"_postman_id":"eaea880a-09fc-448c-aa38-d035fc3db709"},{"name":"Create document definition","id":"0e669ee6-e737-4916-af68-0c83a56c8512","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"user_contract_doc\",\r\n \"identifier\": \"doc\",\r\n \"optional\": false,\r\n \"mimeType\": \"application\\/pdf\"\r\n}"},"url":"/api/v1//documentdefinitions","description":"Creates the definition for a new document. Document definition is a configuration that tells the IDnow system which documents are required from the user to carry out the eSigning identification.
\nNote: A document definition only needs to be created once for each customer account before running the first ident. Document definitions need not be created for each ident.
\n","urlObject":{"path":["api","v1","","documentdefinitions"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"5ddea24f-b6dd-402e-a251-b0fa8c4b2dea","name":"Create document definition 201","originalRequest":{"method":"POST","header":[{"key":"X-API-LOGIN-TOKEN","value":"96de0ea3-e9f1-4668-927f-1cce9dcb2630"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"user_contract_doc\",\r\n \"identifier\": \"doc\",\r\n \"optional\": false,\r\n \"mimeType\": \"application\\/pdf\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1//documentdefinitions"},"status":"Created","code":201,"_postman_previewlanguage":"plain","header":[{"key":"Vary","value":"Origin"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Tue, 25 Jun 2019 09:18:13 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":""},{"id":"27120956-11ee-4ea5-bf0e-12ad32f5f8b6","name":"Create document definition 401","originalRequest":{"method":"POST","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"name\":\"user_contract_doc\",\"identifier\":\"doc\",\"optional\":false,\"mimeType\":\"application\\/pdf\"}","options":{"raw":{"language":"json"}}},"url":"/api/v1//documentdefinitions"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Vary","value":"Origin"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Tue, 25 Jun 2019 09:17:08 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":""},{"id":"dcbfe592-c199-497f-a9db-40cec31529c2","name":"Create document definition 412","originalRequest":{"method":"POST","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"**(REQUIRED)** Your private Auth Token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"**(REQUIRED)** The media type","type":"text"}],"body":{"mode":"raw","raw":"{\"name\":\"user_contract_doc\",\"identifier\":\"doc\",\"optional\":false,\"mimeType\":\"application\\/pdf\"}","options":{"raw":{"language":"json"}}},"url":"/api/v1//documentdefinitions"},"status":"Precondition Failed","code":412,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"175"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Tue, 25 Jun 2019 07:27:35 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"cause\": \"PRECONDITION_FAILED\",\n \"errorType\": null,\n \"id\": \"18883617\",\n \"key\": null,\n \"message\": \"The customer 'testbank' is not an esigning customer!\",\n \"translationKey\": null\n }\n ]\n}"}],"_postman_id":"0e669ee6-e737-4916-af68-0c83a56c8512"},{"name":"Update document definition","id":"d77394e2-1bf6-4189-9a87-de58ef67457b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"(REQUIRED) Your private Auth Token
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(REQUIRED) The media type
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"optional\": false,\n \"name\": \"Contract2\",\n \"identifier\": \"doc\",\n \"mimeType\": \"application/pdf\",\n \"sortOrder\": 0\n}"},"url":"/api/v1//documentdefinitions/{{DOCUMENT-DEFINITION-IDENTIFIER}}","description":"It is the boolean which mentions whether document required or not. If True or Yes, then a default document is provided. If false or no then no default document is provided.
\nThe name field cannot have values that contain accented or special characters. Only allowed characters are a-z, -, _
(REQUIRED) Your private Auth Token
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(REQUIRED) The media type
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"optional\": false,\n \"name\": \"user_contract_doc\",\n \"identifier\": \"doc\",\n \"mimeType\": \"application/pdf\",\n \"sortOrder\": 0\n}"},"url":"/api/v1//documentdefinitions/{{DOCUMENT-DEFINITION-IDENTIFIER}}","description":"Removes the existing document definition from the database. Once the document definition deleted it cannot be recovered.
\n","urlObject":{"path":["api","v1","","documentdefinitions","{{DOCUMENT-DEFINITION-IDENTIFIER}}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"9d55f7ee-0fc5-4ac3-8ca7-2e23c0faed60","name":"Delete document definition 404","originalRequest":{"method":"POST","header":[{"key":"X-API-LOGIN-TOKEN","value":"96de0ea3-e9f1-4668-927f-1cce9dcb2630","description":"**(REQUIRED)** Your private Auth Token","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"**(REQUIRED)** The media type","type":"text"}],"body":{"mode":"raw","raw":"{\n \"optional\": false,\n \"name\": \"Vertrag1234\",\n \"identifier\": \"doc1\",\n \"mimeType\": \"application/pdf\",\n \"sortOrder\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/api/v1//documentdefinitions/{{DOCUMENT-DEFINITION-IDENTIFIER}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"164"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Tue, 25 Jun 2019 07:42:55 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"cause\": \"OBJECT_NOT_FOUND\",\n \"errorType\": null,\n \"id\": \"68666218\",\n \"key\": \"identifier\",\n \"message\": \"no matching documentDefinition found\",\n \"translationKey\": null\n }\n ]\n}"}],"_postman_id":"02961684-52ad-49fd-831a-84ab4c87af65"},{"name":"List document definitions","id":"58f9b589-0b4a-4e0e-ac04-b303f99515d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"(REQUIRED) Your private Auth Token
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(REQUIRED) The media type
\n","type":"text"}],"url":"/api/v1//documentdefinitions","description":"The API allows the user to get list of documents definitions associated with customer or company whose service the user is subscribed to or has subscription.
\n","urlObject":{"path":["api","v1","","documentdefinitions"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"023c90b8-fba6-452e-8277-23dd11859bbc","name":"List document definitions 200","originalRequest":{"method":"GET","header":[{"key":"X-API-LOGIN-TOKEN","value":"96de0ea3-e9f1-4668-927f-1cce9dcb2630","description":"**(REQUIRED)** Your private Auth Token","type":"text"},{"key":"Content-Type","value":"application/json","description":"**(REQUIRED)** The media type","type":"text"}],"url":"/api/v1//documentdefinitions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin,Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"185"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Tue, 25 Jun 2019 10:13:23 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"optional\": false,\n \"name\": \"Doc\",\n \"identifier\": \"doc\",\n \"mimeType\": \"application/pdf\",\n \"sortOrder\": 1,\n \"viewPolicy\": \"DEFAULT\"\n },\n {\n \"optional\": false,\n \"name\": \"AGB eSign\",\n \"identifier\": \"gtu\",\n \"mimeType\": \"application/pdf\",\n \"sortOrder\": 2,\n \"viewPolicy\": \"DEFAULT\"\n },\n {\n \"optional\": false,\n \"name\": \"AGB_Contract\",\n \"identifier\": \"agb_contract\",\n \"mimeType\": \"application/pdf\",\n \"sortOrder\": 3,\n \"viewPolicy\": \"DEFAULT\"\n }\n]"}],"_postman_id":"58f9b589-0b4a-4e0e-ac04-b303f99515d7"},{"name":"Single document definition","id":"adbfc442-d036-4c18-ae75-5a774914ea23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"(REQUIRED) Your private Auth Token
\n","key":"X-API-LOGIN-TOKEN","type":"text","value":"{{LOGIN-TOKEN}}"},{"description":"(REQUIRED) The media type
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"/api/v1//documentdefinitions/{{DOCUMENT-DEFINITION-IDENTIFIER}}","description":"The API allows the user to retrieve single document definition based on the document definition identifier passed in the request.
\n","urlObject":{"path":["api","v1","","documentdefinitions","{{DOCUMENT-DEFINITION-IDENTIFIER}}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"5f1eaa0a-ca23-4a84-96d2-d587e1e2c8bc","name":"Single document definition 200","originalRequest":{"method":"GET","header":[{"description":"**(REQUIRED)** Your private Auth Token","key":"X-API-LOGIN-TOKEN","type":"text","value":"{{LOGIN-TOKEN}}"},{"description":"**(REQUIRED)** The media type","key":"Content-Type","type":"text","value":"application/json"}],"url":"/api/v1//documentdefinitions/{{DOCUMENT-DEFINITION-IDENTIFIER}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin,Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"124"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Tue, 25 Jun 2019 09:30:44 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"optional\": false,\n \"name\": \"user_contract_doc\",\n \"identifier\": \"doc\",\n \"mimeType\": \"application/pdf\",\n \"sortOrder\": 2,\n \"viewPolicy\": \"DEFAULT\"\n}"},{"id":"4d3f399d-8058-4fa5-9357-c26c02f97257","name":"Single document definition 404","originalRequest":{"method":"GET","header":[{"description":"**(REQUIRED)** Your private Auth Token","key":"X-API-LOGIN-TOKEN","type":"text","value":"{{LOGIN-TOKEN}}"},{"description":"**(REQUIRED)** The media type","key":"Content-Type","type":"text","value":"application/json"}],"url":"/api/v1//documentdefinitions/{{DOCUMENT-DEFINITION-IDENTIFIER}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"164"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Tue, 25 Jun 2019 09:30:16 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"cause\": \"OBJECT_NOT_FOUND\",\n \"errorType\": null,\n \"id\": \"05208620\",\n \"key\": \"identifier\",\n \"message\": \"no matching documentDefinition found\",\n \"translationKey\": null\n }\n ]\n}"}],"_postman_id":"adbfc442-d036-4c18-ae75-5a774914ea23"}],"id":"dba44942-526c-440e-9c2c-b306d86f479e","description":"A document definition is a system configuration that tells the IDnow system about the type of document that will be part of the ID verification QES/eSign flow.
\nImportant Note: Document Definition that you setup via the API for your shortname must match the IDnow backend account configuration as well. Therefore, please contact your IDnow technical or customer success representative to ensure that this configuration and setup is done correctly and validated. If you make any changes to the document definition, please ensure to let your IDnow technical contact know, so that the backend configs can be updated to align with your changes.
\nA document definition only needs to be created once for each customer shortname before starting the first ident. Document definitions do not need to be created for each Ident.
\nMultiple document definitions can be created for a shortname each with a unique 'identifier'.
\nA Document definition 'identifier' has a specific naming convention. It must be ensured that the 'identifier' meets the below requirements.
\n'Identifier' can be single or multi-word strings
\nStarts with one or more word characters
\nMulti-word 'identifier' strings must be separated by underscores
\nEnds with one or more word characters
\nA document definition only needs to be created when using the Contract Signing use case for a shortname.
\nFor the ID verification flow without Contract Signing (i.e. QES-only flow), it is not required to manually create a document definition. These are created automatically by the system when the first ident is started.
\nFor the Contract Signing use case, AutoIdent supports signing up to 10 contract documents during an Ident. Please note that for each document to be signed, a corresponding document definition must be created.
\nThe value of the identifier field specified while creating the Document Definition must match the IDnow backend account configuration. Please contact your IDnow Solution Engineering or Customer Success representative to ensure this configuration and setup is done correctly and validated.
The identifier and name fields do not accept accented or special characters. Do not specify values of these fields that contain accented or special characters. Hyphens and underscores are accepted.
The ident creation process is similar to creating a regular ident request. However, when creating an ident request for AutoIdent QES / eSign, below fields are required need to be additionally specified in the CREATE IDENT request
\n*Required Fields:
\nfirstname, lastname - always mandatory
mobilephone and preferredLang - mandatory for Namirial TSP only. These two parameters are not required to be sent in the API call when using the IDnow Trust Services.
For the firstname and lastname fields, the only allowed characters are A-Z, a-z, -
No commas, accented or special characters are allowed in the firstname and lastname fields except the aforementioned ones.
mobilephone should be specified along with country code in the format + as shown in the example below.
preferredLang is a language parameter required by the TSP (Namirial) for the QES eSign Flow. Note that this preferredLang parameter has no impact on the display language (UI language) in the app/sdk. This parameter is not required when creating idents for regular AutoIdent, is only required when creating QES/eSIGN ident requests.
The below example shows the preferredLang parameter in the body of the CREATE IDENT call with Namirial TSP:
\n{ \n \"firstname\":\"John\", \n \"lastname\":\"Smith\",\n \"mobilephone\":\"+490778899000\",\n \"preferredLang\":\"en\"\n}\n\nIf you are enabled with IDnow Trust Services AB, only firstname and lastname are mandatory.
{ \n \"firstname\":\"John\", \n \"lastname\":\"Smith\"\n}\n\nPlease get in touch with your Account manager/Customer Success representative to know which Trust Service Provider(TSP) your account is enabled with(Namirial or IDnow Trust Services)
\n","_postman_id":"2267a9bf-c000-4dab-b2bc-58edf33aef5c"},{"name":"Document Signing","item":[{"name":"Upload document to be signed","item":[{"name":"Upload document","id":"e0047cd4-2da4-46e3-9f79-f67ca5a0e815","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"(REQUIRED) Your private Auth Token
\n","type":"text"},{"key":"Content-Type","value":"application/pdf","description":"(REQUIRED) The media type
\n","type":"text"}],"body":{"mode":"file","file":{"src":""}},"url":"/api/v1//identifications//documents/{{DOCUMENT-DEFINITION-IDENTIFIER}}/data","description":"Allows a document to be uploaded for the purposes of document signing during ID verification. These documents would differ for each user, e.g. the contract to be signed by a user will likely have the user's name on it and therefore will need to be uploaded for every IdentID.
\nNote -
\nThe maximum number of documents that can be uploaded in a single ident is 25.
\nBy default limit for the maximum document size is 50MB. Please note - this 50MB limit is the combined limit of all documents uploaded per ident e.g. if an ident has 3 documents to be signed, combined file size of these 3 documents should not exceed 50MB.
\nOnce the ident request for document signing has been created, the document to be signed must be uploaded before the user starts the identification process. The following API endpoint allows a contract document to be uploaded for an identification request.
\nNOTE: A document must be uploaded for each document signing ident request. If the document is not uploaded, the user will not be able to start the signature/identification process.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"734fbac3-cfe1-4fc9-b89e-8c0526de085a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"945ebaef-b5c3-4b39-9fca-54847d3d8ed7"}}],"_postman_id":"94fe6575-d74d-4b79-92b1-67a9de4f8c05"},{"name":"View document to be signed","item":[{"name":"Single document","id":"8295784b-2368-4c68-bd7a-9a14b421b608","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"(REQUIRED) Your private Auth Token
\n","key":"X-API-LOGIN-TOKEN","type":"text","value":"{{LOGIN-TOKEN}}"},{"description":"(REQUIRED) The media type
\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"/api/v1//identifications//documents/{{DOCUMENT-DEFINITION-IDENTIFIER}}","description":"This request allows viewing the details and status of a single document that will be signed during the ident process.
\n","urlObject":{"path":["api","v1","","identifications","","documents","{{DOCUMENT-DEFINITION-IDENTIFIER}}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"78cf92ee-a997-4d3a-afb0-0750cd5e0782","name":"Single document 200 (status: UPLOADED)","originalRequest":{"method":"GET","header":[{"description":"**(REQUIRED)** Your private Auth Token","key":"X-API-LOGIN-TOKEN","type":"text","value":"{{LOGIN-TOKEN}}"},{"description":"**(REQUIRED)** The media type","key":"Content-Type","type":"text","value":"application/json"}],"url":"/api/v1//identifications//documents/{{DOCUMENT-DEFINITION-IDENTIFIER}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin,Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"222"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Tue, 25 Jun 2019 09:59:13 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Doc\",\n \"hash\": \"2fc286667a0f569bec74f4a2db74c6d021f3b23029749e11ed66df5160a1809f\",\n \"displayHash\": \"2fc2-8666-7a0f\",\n \"status\": \"UPLOADED\",\n \"documentDefinition\": {\n \"optional\": false,\n \"name\": \"Doc\",\n \"identifier\": \"doc\",\n \"mimeType\": \"application/pdf\",\n \"sortOrder\": 1,\n \"viewPolicy\": \"SCROLL\"\n }\n}"},{"id":"e035f40c-0c23-4df7-923c-4bc941cd2352","name":"Single document 200 (status: NEED_UPLOAD)","originalRequest":{"method":"GET","header":[{"description":"**(REQUIRED)** Your private Auth Token","key":"X-API-LOGIN-TOKEN","type":"text","value":"{{LOGIN-TOKEN}}"},{"description":"**(REQUIRED)** The media type","key":"Content-Type","type":"text","value":"application/json"}],"url":"/api/v1//identifications//documents/{{DOCUMENT-DEFINITION-IDENTIFIER}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"vary","value":"Origin,Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"date","value":"Sun, 30 Jan 2022 17:59:50 GMT"},{"key":"content-length","value":"163"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"strict-transport-security","value":"max-age=16000000;"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Contract2\",\n \"status\": \"NEED_UPLOAD\",\n \"documentDefinition\": {\n \"optional\": false,\n \"name\": \"Contract2\",\n \"identifier\": \"doc\",\n \"mimeType\": \"application/pdf\",\n \"sortOrder\": 2,\n \"viewPolicy\": \"DEFAULT\"\n }\n}"}],"_postman_id":"8295784b-2368-4c68-bd7a-9a14b421b608"},{"name":"List documents","id":"be0456df-2f45-4ddf-b2e7-f9f12a9d4bca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"(REQUIRED) Your private Auth Token
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(REQUIRED) The media type
\n","type":"text"}],"url":"/api/v1//identifications//documents","description":"This request lists the details and statuses of documents that are associated with a partcular transaction number.
\nNote: A transaction number is number that user assigns on their discretion when creating the ident ID. It has maximum 255 characters and contains only this character (a-z) (A-Z) (_ -). The transaction number is unique to a single ident. If a transaction number is deleted the same number cannot be used to create another ident. The transaction number is passed as header parameter in the URL.
\n","urlObject":{"path":["api","v1","","identifications","","documents"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"40b851ea-4591-4864-a542-5207fa12447e","name":"List documents 200","originalRequest":{"method":"GET","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"**(REQUIRED)** Your private Auth Token","type":"text"},{"key":"Content-Type","value":"application/json","description":"**(REQUIRED)** The media type","type":"text"}],"url":"/api/v1//identifications//documents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin,Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"318"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Tue, 25 Jun 2019 09:56:11 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"contract_Doc\",\n \"hash\": \"2fc286667a0f569bec74f4a2db74c6d021f3b23029749e11ed66df5160a1809f\",\n \"displayHash\": \"2fc2-8666-7a0f\",\n \"status\": \"UPLOADED\",\n \"documentDefinition\": {\n \"optional\": false,\n \"name\": \"contract_Doc\",\n \"identifier\": \"doc\",\n \"mimeType\": \"application/pdf\",\n \"sortOrder\": 1,\n \"viewPolicy\": \"SCROLL\"\n }\n },\n {\n \"name\": \"signature_contract\",\n \"hash\": \"e7b3acb69263181c74a25a211230ceb779f968a795e883fcaf51dfb46430e2c8\",\n \"displayHash\": \"e7b3-acb6-9263\",\n \"status\": \"UPLOADED\",\n \"documentDefinition\": {\n \"optional\": false,\n \"name\": \"signature_contract\",\n \"identifier\": \"sign_contract\",\n \"mimeType\": \"application/pdf\",\n \"sortOrder\": 4,\n \"viewPolicy\": \"DEFAULT\"\n }\n }\n]"}],"_postman_id":"be0456df-2f45-4ddf-b2e7-f9f12a9d4bca"}],"id":"71207dae-d319-4682-8c09-fe7d75ca35f3","description":"This request allows viewing the contract document that was uploaded for an identification/document signing process.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"a2c9957c-fae6-4501-aaa1-1631e17c0567"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"872bcaef-85ab-4096-a468-5573f05f408b"}}],"_postman_id":"71207dae-d319-4682-8c09-fe7d75ca35f3"},{"name":"Download Signed Document","item":[{"name":"Download Signed Document ","id":"5c651fc2-2444-4a82-9752-f47906e5642c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"(REQUIRED) Your private Auth Token
\n","type":"text"},{"key":"Content-Type","value":"application/pdf","description":"(REQUIRED) The media type
\n","type":"text"}],"url":"/api/v1//identifications//documents/{{DOCUMENT-DEFINITION-IDENTIFIER}}/signed","description":"This request downloads the signed document.
\n","urlObject":{"path":["api","v1","","identifications","","documents","{{DOCUMENT-DEFINITION-IDENTIFIER}}","signed"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"21a9dfd5-8903-4176-92cc-8a46daf664e5","name":"Download Signed Document 200","originalRequest":{"method":"GET","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"**(REQUIRED)** Your private Auth Token","type":"text"},{"key":"Content-Type","value":"application/pdf","description":"**(REQUIRED)** The media type","type":"text"}],"url":"/api/v1//identifications//documents/{{DOCUMENT-DEFINITION-IDENTIFIER}}/signed"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"78443b19-9187-4d46-b1e5-0051714d3d8a","name":"Download Signed Document 404","originalRequest":{"method":"GET","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"**(REQUIRED)** Your private Auth Token","type":"text"},{"key":"Content-Type","value":"application/pdf","description":"**(REQUIRED)** The media type","type":"text"}],"url":"/api/v1//identifications//documents/{{DOCUMENT-DEFINITION-IDENTIFIER}}/signed"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-origin","value":"*"},{"key":"date","value":"Fri, 28 Jan 2022 12:32:57 GMT"},{"key":"content-length","value":"162"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"strict-transport-security","value":"max-age=16000000;"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"cause\": \"OBJECT_NOT_FOUND\",\n \"errorType\": null,\n \"id\": \"77518249\",\n \"key\": \"identifier\",\n \"message\": \"Unable to find document definition\",\n \"translationKey\": null\n }\n ]\n}"},{"id":"368957c2-e312-405d-b71d-3592ac32834b","name":"Download Signed Document 400","originalRequest":{"method":"GET","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"**(REQUIRED)** Your private Auth Token","type":"text"},{"key":"Content-Type","value":"application/pdf","description":"**(REQUIRED)** The media type","type":"text"}],"url":"/api/v1//identifications//documents/{{DOCUMENT-DEFINITION-IDENTIFIER}}/signed"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-origin","value":"*"},{"key":"date","value":"Sun, 30 Jan 2022 18:47:56 GMT"},{"key":"content-length","value":"153"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"strict-transport-security","value":"max-age=16000000;"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"cause\": \"BAD_REQUEST\",\n \"errorType\": null,\n \"id\": \"04622400\",\n \"key\": \"document\",\n \"message\": \"Document has not yet been signed\",\n \"translationKey\": null\n }\n ]\n}"}],"_postman_id":"5c651fc2-2444-4a82-9752-f47906e5642c"}],"id":"a7dfc4cb-f50d-4584-a67c-07e1e7984681","description":"The document(s) signed during an identification process will be available in the result ZIP file. This result ZIP file includes both the original document that was uploaded and the signed version of that document.
\nAdditionally, it is possible to download the signed document using the following API request.
\n","_postman_id":"a7dfc4cb-f50d-4584-a67c-07e1e7984681"}],"id":"de3d550a-2079-4394-9330-85c671f4008e","description":"For each identification request with document signing, you can upload the document to be signed, list the documents to be signed and finally get the signed result of the identification.
\n","_postman_id":"de3d550a-2079-4394-9330-85c671f4008e"}],"id":"3a63e391-f051-4e76-83d3-b62b0c758264","description":"AutoIdent supports performing ID Verification using qualified electronic signatures in compliance with AML regulations, using the QES/eSign module. The following use cases are supported:
\nAML-compliant ID Verification with Contract Signing: The document to be signed (such as a Contract document) must be uploaded while creating an identification request using the Upload Document API call. This document will then be digitally signed during the identification process. Document signing cannot be done separately without the ID Verification step.
\nAML-compliant ID Verification without Contract Signing: In this case, the ident data itself gets signed; therefore, uploading a separate document while creating the identification request is not necessary.
\nGwG-compliant ID Verification: Our add-on 'Bank Transfer' component can be combined with the QES/eSign component, with or without Contract Signing, making the ID verification process compliant with GwG regulations. These regulations are specific only to Germany.
\nDocuments (e.g. the Contract PDF document which are to be signed by the user) can be provided by:
\nUploading them using the Upload Document API for the specific and {{DOCUMENT-DEFINITION-IDENTIFIER}} which was used to create the identification request.
AutoIdent supports signing up to 10 documents, provided by the customer, during an Ident. Please ensure that Document definitions have been created for each contract document that needs to be signed. A maximum of 10 documents can be signed in an ident.
\nAutoIdent supports scanning the chip on the document using NFC as an optional add-on feature. ID documents and Passports have a chip containing a cryptographically signed version of the document's information. AutoIdent can scan this chip can and validate the data on it using public keys. You can use our NFC scanning feature to enhance the data readout quality, establish document authenticity and have a higher level of fraud protection. The NFC step replaces the hologram detection step during the ID verification user flow when supported by the the document being scanned, and the device hardware. NFC scanning also greatly improves the end-user experience. All ICAO 9303 eMRTD compliant documents are supported.
\nNFC scanning for the AutoIdent SDK requires an additional SDK component. If you are interested in using the NFC capability, please reach out to your IDnow account manager to obtain the required dependencies (NFC SDK) and further information on its usage. The AutoIdent native apps already include this component.
\n","_postman_id":"53eddc13-38aa-41e4-b892-e8c22a2842cd"},{"name":"Proof Of Address Validation","item":[],"id":"f4c26137-7794-4d3a-acaa-988e7116be3f","description":"Proof of Address (PoA) is an optional add-on module for AutoIdent that enables validation of a user's current address through the review of an accepted and valid PoA document. It allows users to provide additional address documents such as utility bills or bank statements. Users can either capture a picture or upload a valid proof of address document during the ID verification flow. Ident specialists then review the document, cross-checking the address on the PoA document with the address information provided in the original data during the Ident request creation.
\nPlease refer to the 'Ident Requests & Results' > 'Result Data' > Section 'additionaldocuments' below for more details on the Proof of Address results and responses. Sample responses are here: XML, JSON
\n","_postman_id":"f4c26137-7794-4d3a-acaa-988e7116be3f"},{"name":"Ident Requests & Results","item":[{"name":"Retrieving Data via REST API","item":[{"name":"Retrieving an Ident in its various Statuses","item":[],"id":"93af4052-8040-40f5-94ef-f124701c3a03","description":"By adding a query string to your GET requests, you can retrieve a list of Idents that are in the specified status.
For example, sending the pending = true parameter will return a list of all idents that are in the REVIEW_PENDING (i.e. awaiting manual review) state.
GET /identifications?pending=true\n\nAllowed parameters are as follows:
\nThe successful = true parameter will return a list of all idents, for your shortname, that are in the Finished state, i.e. Idents that have had a final outcome and are in the statuses SUCCESS,SUCCESS_DATA_CHANGED and FRAUD_SUSPICION_CONFIRMED
The recommended way for retrieving Ident data is via the REST API.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"f1e1e31b-7ea2-4373-a2fe-6565500882e4"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"9ea16701-cc1d-4ab5-8706-5945ee6f667c"}}],"_postman_id":"8326963f-9e17-4a91-93ac-672b19848fce"},{"name":"Ident data field status values","item":[],"id":"b41839e9-294e-4e06-a7f9-7d5fe090eb2f","description":"Comparison of data fields from the Ident can have the following values:
\n","_postman_id":"b41839e9-294e-4e06-a7f9-7d5fe090eb2f"},{"name":"Ident data field status values after review","item":[],"id":"1b7624c2-40dc-4da9-805c-1cd75d9e2c6e","description":"The status of ident data elements after review can have the following values:
\nExample 1: Matching firstname field in XML:
...\n ARMIN\n...\n\nExample 2: New nationality field in JSON:
...\n nationality: {\n value: “DE”,\n status: “NEW”,\n reviewstatus: “MATCH”\n },\n...\n\nExample 3: Changed birthday field in XML:
... \n 1983-05-22\n...\n\nExample 4: Changed birthday field in JSON:
\n...\n birthday: {\n value: “1983-05-22”,\n status: “CHANGE”, \n reviewstatus: “MATCH”,\n original: “1982-05-22\n },\n...\n\nExample 5: Birthday for an aborted or failed identification in JSON:
\n...\n birthday: {\n status\": \"ORIGINAL\",\n original: \"1981-07-02\"\n },\n...\n\nExample 6: Birthday changed during review and during identification (bank sent 02.07.1981, after ident 21.05.1983, reviewer corrected to 22.05.1983):
\n...\n birthday: {\n value: “1983-05-22”,\n status\": \"CHANGE\",\n reviewstatus\": \"CHANGE\",\n original: \"1981-07-02\",\n identification: \"1983-05-21\"\n },\n...\n\nExample 7: Title entered after review only (agent missed title, reviewer corrected to correct title):
\n...\n title: {\n value: “Dr.”,\n status\": \"MATCH\",\n reviewstatus\": \"NEW\"\n },\n...\n\nThis section holds the result and general information about the identification process. This section is marked by the key identificationprocess.
The description of fields in this section are as follows:
\nThe \"result\" field in the JSON response or XML result file can have the following values:
\nNOTE1: Not all idents are completed immediately, they may undergo a review for example. For this reason there are both final and preliminary results.
\nNOTE2: Idents that have the final outcome as SUCCESS,SUCCESS_DATA_CHANGED, and FRAUD_SUSPICION_CONFIRMEDare Finished idents which cannot be restarted by the user. Idents that have the result as CANCELED, as explained above are inconclusive or incorrectly performed and are therefore not Final. It is recommended for customers to allow their end users to try a second time and restart such idents by reusing the same IdentID.
Additional reference: See the section Final Result for more details about Ident results.
\n","_postman_id":"f6cfb454-bb39-48cd-836e-d5092f832770"},{"name":"Section 'customdata'","item":[],"id":"e3df1889-5a5b-4221-abdf-9743ffe91582","description":"This section holds the custom data which can be passed when creating an Identification. This section is marked by the key customdata.
The values received in any of the custom fields will simply be relayed back in the final result after the identification. This can, for instance, help you map values with your internal systems.
\n","_postman_id":"e3df1889-5a5b-4221-abdf-9743ffe91582"},{"name":"Section 'contactdata'","item":[],"id":"e4d4299f-c39e-42ef-8edc-ec82e962b2eb","description":"This section holds the contact data of the user. This data can be passed when creating the Identification. If the user changes the data (for example the mobile phone) during the identification process, you will get back the updated value in the result.
\nThis section is marked with the key contactdata.
This section holds the personal data of the user as retrieved during the identification. You will also get information if data for any of the fields has been changed. This section is marked by the key userdata.
This 'userdata' section also contains address fields in it - these fields typically contain the address value read from the ID document, if it exists.
\n","_postman_id":"7ecce9ee-df0e-47fb-92e1-a27a9d610f03"},{"name":"Section 'identificationdocument'","item":[],"id":"3183996c-e598-47b5-86e2-97fffc9fc8e6","description":"This section in the result response provides the readout data and details about the identification document used by the user.
\nSome document types do not have the address data available on them. In such cases, it's not possible to read the address from the document, and the address fields in the results will therefore be empty.
\nThe data objects in the array driverlicenses are as follows:
Example backside of a German driver's license:
\nExample driverlicenses section (JSON)
This JSON response object shows the readout from the back side of the above driver's license sample.
\nCurrently, all fields are read out by AutoIdent.
\nNote that Austrian driver's licenses with all fields empty are handled as invalid.
\n\"driverlicenses\": [\n {\n \"additionalInformation\": null,\n \"licenseClass\": \"A1\",\n \"validFromReadout\": \"EMPTY\",\n \"validUntilReadout\": \"EMPTY\",\n \"validUntil\": null,\n \"validFrom\": null\n },\n {\n \"additionalInformation\": null,\n \"licenseClass\": \"A\",\n \"validFromReadout\": \"EMPTY\",\n \"validUntilReadout\": \"EMPTY\",\n \"validUntil\": null,\n \"validFrom\": null\n },\n {\n \"additionalInformation\": null,\n \"licenseClass\": \"A\",\n \"validFromReadout\": \"EMPTY\",\n \"validUntilReadout\": \"EMPTY\",\n \"validUntil\": null,\n \"validFrom\": null\n },\n {\n \"additionalInformation\": null,\n \"licenseClass\": \"B\",\n \"validFromReadout\": \"REFERENCE_GERMAN\",\n \"validUntilReadout\": \"EMPTY\",\n \"validUntil\": null,\n \"validFrom\": null\n },\n {\n \"additionalInformation\": null,\n \"licenseClass\": \"C1\",\n \"validFromReadout\": \"EMPTY\",\n \"validUntilReadout\": \"EMPTY\",\n \"validUntil\": null,\n \"validFrom\": null\n },\n {\n \"additionalInformation\": null,\n \"licenseClass\": \"C\",\n \"validFromReadout\": \"EMPTY\",\n \"validUntilReadout\": \"EMPTY\",\n \"validUntil\": null,\n \"validFrom\": null\n },\n {\n \"additionalInformation\": null,\n \"licenseClass\": \"D1\",\n \"validFromReadout\": \"EMPTY\",\n \"validUntilReadout\": \"EMPTY\",\n \"validUntil\": null,\n \"validFrom\": null\n },\n {\n \"additionalInformation\": null,\n \"licenseClass\": \"D\",\n \"validFromReadout\": \"EMPTY\",\n \"validUntilReadout\": \"EMPTY\",\n \"validUntil\": null,\n \"validFrom\": null\n },\n {\n \"additionalInformation\": null,\n \"licenseClass\": \"BE\",\n \"validFromReadout\": \"EMPTY\",\n \"validUntilReadout\": \"EMPTY\",\n \"validUntil\": null,\n \"validFrom\": null\n },\n {\n \"additionalInformation\": null,\n \"licenseClass\": \"C1E\",\n \"validFromReadout\": \"EMPTY\",\n \"validUntilReadout\": \"EMPTY\",\n \"validUntil\": null,\n \"validFrom\": null\n },\n {\n \"additionalInformation\": null,\n \"licenseClass\": \"CE\",\n \"validFromReadout\": \"EMPTY\",\n \"validUntilReadout\": \"EMPTY\",\n \"validUntil\": null,\n \"validFrom\": null\n },\n {\n \"additionalInformation\": null,\n \"licenseClass\": \"D1E\",\n \"validFromReadout\": \"EMPTY\",\n \"validUntilReadout\": \"EMPTY\",\n \"validUntil\": null,\n \"validFrom\": null\n },\n {\n \"additionalInformation\": null,\n \"licenseClass\": \"DE\",\n \"validFromReadout\": \"EMPTY\",\n \"validUntilReadout\": \"EMPTY\",\n \"validUntil\": null,\n \"validFrom\": null\n },\n {\n \"additionalInformation\": null,\n \"licenseClass\": \"M\",\n \"validFromReadout\": \"DATE\",\n \"validUntilReadout\": \"EMPTY\",\n \"validUntil\": null,\n \"validFrom\": \"2010-06-15\"\n },\n {\n \"additionalInformation\": null,\n \"licenseClass\": \"L\",\n \"validFromReadout\": \"REFERENCE_GERMAN\",\n \"validUntilReadout\": \"EMPTY\",\n \"validUntil\": null,\n \"validFrom\": null\n },\n {\n \"additionalInformation\": null,\n \"licenseClass\": \"T/S\",\n \"validFromReadout\": \"REFERENCE_GERMAN\",\n \"validUntilReadout\": \"EMPTY\",\n \"validUntil\": null,\n \"validFrom\": null\n }\n ]\n\nThis section lists the filenames of all the attachments (images, etc.) that are contained in the result zip file.
\nAttachments pertaining to the Ident results are included in the result ZIP file for an Ident. The list of attachments and their filenames are available in the attachments block in the XML result file and also in the JSON response of the GET Ident call. Examples:
<attachments>\n <pdf>AH73JK3LM.pdf</pdf>\n <xml>AH73JK3LM.pdf</xml>\n <idfrontside>AH73JK3LM_idfrontside.jpg</idfrontside>\n <idbackside>AH73JK3LM_idbackside.jpg</idbackside>\n <userface>AH73JK3LM_userface.jpg</userface>\n <security1>AH73JK3LM_security1.jpg</security1>\n <security2>AH73JK3LM_security2.jpg</security2>\n <security3>AH73JK3LM_security3.jpg</security3>\n</attachments>\n\n\"attachments\": {\n \"pdf\": \"demosecurityfeatures_20190528.pdf\",\n \"xml\": \"demosecurityfeatures_20190528.xml\",\n \"security4\": \"demosecurityfeatures_20190528.jpg\",\n \"idbackside\": \"demosecurityfeatures_20190528_idbackside.jpg\",\n \"idfrontside\": \"demosecurityfeatures_2019052_idfrontside.jpg\",\n \"security1\": \"demosecurityfeatures_20190528_security1.jpg\",\n \"userface\": \"demosecurityfeatures_20190528_userface.jpg\",\n \"security2\": \"demosecurityfeatures_20190528_security2.jpg\",\n \"security3\": \"demosecurityfeatures_20190528_security3.jpg\"\n }\n\nThe 'IdentificationProcess' section above contains the poaresult field that indicates if the overall Proof of Address check was successful or not.
This section 'additionaldocuments' of the JSON response provides values of the Proof of Address fields and of any other additional document that was captured by the user during the identification flow.
\nSample JSON response object is shown below
\n...\n\"additionaldocuments\": [\n {\n \"documentname\": \"UTILITY_BILL\",\n \"address\": {\n \"zipcode\": {\n \"status\": \"MATCH\",\n \"value\": \"80469\"\n },\n \"country\": {\n \"status\": \"MATCH\",\n \"value\": \"DE\"\n },\n \"city\": {\n \"status\": \"MATCH\",\n \"value\": \"MUNICH\"\n },\n \"street\": {\n \"status\": \"MATCH\",\n \"value\": \"HIGH STREET\"\n },\n \"streetnumber\": {\n \"status\": \"MATCH\",\n \"value\": \"100\"\n }\n }\n }\n ]\n...\n\nAborted idents are basically User cancellations, where the user aborted and never completed the ident process in the app. An aborted ident triggers a webhook that contains the user-selected abort reason in it. The following abort reasons may be sent in a webhook. Additionally, in some cases, the app might abort an ident when it encounters a technical issue and it is not feasible for the user to proceed further.
\nAbort reasons can be of different types:
\nAbort reasons that are shown in the UI (Type: UI) - Users can select one of the abort reasons when aborting the identification process. These reasons provide more insight into why users quit the process at certain steps.
\nAbort reasons based on specific user actions or process related errors (Type: User action) - Abort reasons related to actions of the user such as denying camera access permission or denying the Terms of use or using a document type that is not accepted for an identification process, is automatically logged by the app without the need to show a list of abort reasons in the UI for the user to pick from. The reason for aborting would be obvious in such cases.
\nAbort due to technical issues (Type: Technical) - Scenarios where a technical error or exception occurs and is an irrecoverable scenario, the ident process will be aborted and an abort reason will be logged by the system automatically.
\nNOTE: Only the abort reasons shown in the UI can be customised.
\nTo receive preliminary result status, you must accept REALTIME webhooks. These can have the following values.
\n","_postman_id":"e2048e9f-f703-4b6c-b994-80aa660484f8"},{"name":"Cancelled Idents","item":[],"id":"db569ba9-264d-4572-90a1-96ab7a146835","description":"There can be a number of reasons why an Ident might be cancelled by an agent. If the ident data is inconclusive and agents are unable to make a decision on the Ident during review, the Ident will be cancelled. Document images might have glare or might be blurry making it unreadable for an agent resulting in a cancellation.
\nNote: If an ident is in the Canceled status, the user can retry the identification process again using the same IdentID.
The list of new cancel reasons are listed in the table below. Legacy cancel reasons are in the following table.
\nNew reasons (from 01.09.2021 onwards):
\nLegacy Cancel reasons are listed in the table below. Existing customers using legacy reasons can switch to the new Cancel reasons if there are no issues with their integrations on their backend.
\n","_postman_id":"db569ba9-264d-4572-90a1-96ab7a146835"},{"name":"Final Result","item":[],"id":"38dbc096-2798-4a57-8aba-efd360e2bf56","description":"As indicated earlier, the final result of an Ident can either be SUCCESS, SUCCESS_DATA_CHANGED or FRAUD_SUSPICION_CONFIRMED. These Idents are called 'Finished' Idents. These are in the Finished state, which means that users cannot reuse these IdentIDs to start another attempt.
Another possible outcome of the Ident review process is CANCELED which means that the ident was inconclusive and could not be reviewed by the agent, and must be retried by the user.
Note: Reasons indicated in FINAL webhooks can differ depending on your configuration. The list below is for customers that have opted for the new reason. The legacy list follows.
\nThe table below lists the reasons for the FRAUD_SUSPICION_CONFIRMED result.
New reasons (from 01.09.2021 onwards):
\nLegacy reasons for existing customers are below. Existing customers can switch to new reasons if there are no compatibility limitations on their backend.
\n","_postman_id":"38dbc096-2798-4a57-8aba-efd360e2bf56"}],"id":"87c20deb-5c45-4c7e-bf8d-d59563640323","description":"Depending on the API used for retrieving the results, the result can either be returned as JSON (JavaScript Object Notation, refer to http://en.wikipedia.org/wiki/JSON) or as XML.
\nThe result response consists of various sections. Each section is detailed below.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"29e734fe-2359-4ae5-92d8-47c01722a0a4"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"60e6f309-cccc-46ac-9e3a-6818ecfd2c1a"}}],"_postman_id":"87c20deb-5c45-4c7e-bf8d-d59563640323"},{"name":"Result Attachments","item":[{"name":"Image Format","item":[],"id":"cf500066-f2d1-4c2a-8f7a-5aa2c044ea05","description":"The images provided in the identification result can be provided in the following formats:
\n.jpg.If you need a different format than JPEG, please contact IDnow.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"3f16ef87-57bc-453d-90f0-fe764ad98920"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"4876f715-59ea-4727-ab46-36c75291b739"}}],"_postman_id":"cf500066-f2d1-4c2a-8f7a-5aa2c044ea05"}],"id":"beb1fcc8-24fa-4753-a5c0-e5669840786e","description":"This section provides details on the additional attachments (images, etc.) that are in the result zip file.
\nAttachments pertaining to the Ident results are included in the result ZIP file for an Ident. The list of attachments and their filenames are available in the attachments block in the XML result file and also in the JSON response of the GET Ident call. An example of this attachments block is shown below.
NOTE: Except the PDF and XML result files, it is currently not possible to fetch the other files within the zip file, directly via the API. For instance, it is not possible to directly download the JPG files contained in the zip via the API. The suggested approach is to download the zip and extract the required files from it.
\n<attachments>\n <pdf>AH73JK3LM.pdf</pdf>\n <xml>AH73JK3LM.pdf</xml>\n <idfrontside>AH73JK3LM_idfrontside.jpg</idfrontside>\n <idbackside>AH73JK3LM_idbackside.jpg</idbackside>\n <userface>AH73JK3LM_userface.jpg</userface>\n <security1>AH73JK3LM_security1.jpg</security1>\n <security2>AH73JK3LM_security2.jpg</security2>\n <security3>AH73JK3LM_security3.jpg</security3>\n</attachments>\n\n\"attachments\": {\n \"pdf\": \"demosecurityfeatures_20190528.pdf\",\n \"xml\": \"demosecurityfeatures_20190528.xml\",\n \"security4\": \"demosecurityfeatures_20190528.jpg\",\n \"idbackside\": \"demosecurityfeatures_20190528_idbackside.jpg\",\n \"idfrontside\": \"demosecurityfeatures_2019052_idfrontside.jpg\",\n \"security1\": \"demosecurityfeatures_20190528_security1.jpg\",\n \"userface\": \"demosecurityfeatures_20190528_userface.jpg\",\n \"security2\": \"demosecurityfeatures_20190528_security2.jpg\",\n \"security3\": \"demosecurityfeatures_20190528_security3.jpg\"\n }\n\nWhen using NFC, the result files will contain the data values, which were read out from the NFC chip. The XML result will contain an additional element true to indicate if data was read out from the NFC chip or not.
<identifications>\n <identification>\n <identificationprocess>\n <result>SUCCESS</result>\n <identificationtime>2014-06-02T05:03:54Z</identificationtime>\n <type>APP</type>\n <transactionnumber>AH73JK3LM</transactionnumber>\n <companyid>your_company</companyid>\n <id>IBA-H7GB6</id>\n <wasnfcused>true</wasnfcused>\n </identificationprocess>\n <customdata>\n <custom1>2740332</custom1>\n <custom2>ABCD</custom2>\n </customdata>\n <contactdata>\n <email>hello@democompny.de</email>\n <mobilephone>+491778901234</mobilephone>\n </contactdata>\n <userdata>\n <firstname status=\"MATCH\">OLIVIA</firstname>\n <lastname status=\"MATCH\">JONES</lastname>\n <birthday status=\"CHANGE\" original=\"1982-05-22\">1983-05-22</birthday>\n <birthplace status=\"MATCH\">LONDON</birthplace>\n <nationality status=\"MATCH\">GB</nationality>\n <gender status=\"MATCH\">FEMALE</gender>\n <address class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <street status=\"MATCH\">BAKER STR.</street>\n <streetnumber status=\"MATCH\">40</streetnumber>\n <city status=\"MATCH\">LONDON</city>\n <country status=\"MATCH\">GB</country>\n <zipcode status=\"MATCH\">80469</zipcode>\n </address>\n </userdata>\n <identificationdocument>\n <type status=\"NEW\">IDCARD</type>\n <country status=\"NEW\">DE</country>\n <validuntil status=\"REDACTION\"/>\n <number status=\"REDACTION\"/>\n <issuedby status=\"NEW\">CITYLONDON, LONDON</issuedby>\n <dateissued status=\"NEW\">2012-03-27</dateissued>\n </identificationdocument>\n <attachments>\n <pdf>AH73JK3LM.pdf</pdf>\n <idfrontside>AH73JK3LM_idfrontside.jpg</idfrontside>\n <idbackside>AH73JK3LM_idbackside.jpg</idbackside>\n <userface>AH73JK3LM_userface.jpg</userface>\n <security1>AH73JK3LM_security1.jpg</security1>\n <security2>AH73JK3LM_security2.jpg</security2>\n <security3>AH73JK3LM_security3.jpg</security3>\n </attachments>\n </identification>\n </identifications>\n\nPlease note that the content of the XML file (especially the nodes) varies depending on your configuration.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8c8a9dce-d0ac-4c78-8a63-f7ac952c88ea"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"808cc51c-212f-42fc-b4b4-046b697f6a58"}}],"_postman_id":"88165cb7-b9ca-48ee-a957-95b160ae3be7"},{"name":"XML Result with Proof of Address","item":[],"id":"be84a9df-2bff-49c9-b935-53062c20f949","description":"When using Proof of Address validation, the result files will contain the data values from the PoA document that was submitted by the user. The XML result will contain an additional element poaresult to indicate if the proof of address validation was successful or not.
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\n<identifications>\n <identification>\n <identificationprocess>\n <result>SUCCESS_DATA_CHANGED</result>\n <agentname>TROBOT</agentname>\n <identificationtime>2025-02-07T11:43:41+01:00</identificationtime>\n <type>APP</type>\n <transactionnumber>20250206</transactionnumber>\n <companyid>demoproofofaddress</companyid>\n <id>TS2-LKRHL</id>\n <poaresult>SUCCESS</poaresult>\n </identificationprocess>\n <customdata>\n <custom1>Eg. Employer name</custom1>\n <custom2>Eg. Job Position </custom2>\n <custom3>Eg. Insurance number</custom3>\n <custom4>or store any data strings</custom4>\n <custom5>you like.</custom5>\n </customdata>\n <contactdata>\n <email>hello@democompany.org</email>\n <mobilephone>+441753109660</mobilephone>\n </contactdata>\n <userdata>\n <firstname status=\"MATCH\" >ERIKA</firstname>\n <lastname status=\"CHANGE\" original=\"MUSTERMAN\" >MUSTERMANN</lastname>\n <birthday status=\"CHANGE\" original=\"1987-05-23\" >1964-08-12</birthday>\n <nationality status=\"CHANGE\" original=\"GB\" >DE</nationality>\n <gender status=\"MATCH\" >FEMALE</gender>\n <address>\n <street status=\"ORIGINAL\" >HIGH STREET</street>\n <streetnumber status=\"ORIGINAL\" >100</streetnumber>\n <city status=\"MATCH\" >MUNICH</city>\n <country status=\"ORIGINAL\" >DE</country>\n <zipcode status=\"ORIGINAL\" >80469</zipcode>\n </address>\n </userdata>\n <identificationdocument>\n <country status=\"NEW\" >DE</country>\n <validuntil status=\"NEW\" >2027-02-28</validuntil>\n <number status=\"NEW\" >C01X00T47</number> \n </identificationdocument> \n <additionaldocuments>\n <additionaldocument>\n <documentname>UTILITY_BILL</documentname>\n <address>\n<street status=\"MATCH\" >HIGH STREET</street>\n<streetnumber status=\"MATCH\" >100</streetnumber>\n<city status=\"MATCH\" >MUNICH</city>\n<country status=\"MATCH\" >DE</country>\n<zipcode status=\"MATCH\" >80469</zipcode>\n </address>\n </additionaldocument>\n </additionaldocuments>\n <attachments>\n <pdf>20250206.pdf</pdf>\n <bankstatement>20250206_signature.jpg</bankstatement>\n <utilitybill>20250206_utilitybill.jpg</utilitybill>\n <idfrontside>20250206_idfrontside.jpg</idfrontside>\n </attachments>\n </identification>\n</identifications>\n\nThe XML result will always start with the top-level Ident process information and will then have additional blocks containing contact data, user data, identification data, attachments and so on. Please note that the XML result file will contain additional blocks of information pertaining to any add-on components you may be using, depending on your account configuration.
\nWhen using AutoIdent with QES / eSign (AML, GwG), there will be four additional attachments (PDF files) for the original and signed contract documents.
\n<identifications>\n <identification>\n <identificationprocess>\n <result>SUCCESS_DATA_CHANGED</result>\n <agentname></agentname>\n <identificationtime>2022-04-27T01:49:10+02:00</identificationtime>\n <type>APP</type>\n <transactionnumber>QES-BankTransfer_Sample_Result</transactionnumber>\n <companyid>demobanktransferqesonly</companyid>\n <id>TST-JNSYJ</id> \n </identificationprocess>\n <esigning>\n <result>SUCCESS</result>\n <sessionid></sessionid>\n </esigning>\n <customdata>\n </customdata>\n <contactdata>\n <email>a@b.c</email>\n <mobilephone>+4900636109660</mobilephone>\n </contactdata>\n <userdata>\n <firstname status=\"MATCH\" >ERIKA</firstname>\n <lastname status=\"MATCH\" >MUSTERMANN</lastname>\n <birthday status=\"CHANGE\" original=\"1920-01-01\" >1964-08-12</birthday>\n <birthplace status=\"MATCH\" >MUC</birthplace>\n <nationality status=\"MATCH\" >DE</nationality>\n <gender status=\"CHANGE\" original=\"MALE\" >FEMALE</gender>\n <identlanguage status=\"MATCH\" >en</identlanguage>\n <address class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <street status=\"MATCH\" >AUENSTR</street>\n <streetnumber status=\"MATCH\" >200</streetnumber>\n <city status=\"MATCH\" >MUC</city>\n <country status=\"MATCH\" >DE</country>\n <zipcode status=\"MATCH\" >80339</zipcode>\n </address>\n </userdata>\n <identificationdocument>\n <type status=\"NEW\" >PASSPORT</type>\n <country status=\"NEW\" >DE</country>\n <validuntil status=\"NEW\" >2027-02-28</validuntil>\n <number status=\"NEW\" >C01XYCCG9</number> \n </identificationdocument> \n <attachments>\n <security4>QES-BankTransfer_Sample_Result_security4.jpg</security4>\n <contract-doc>QES-BankTransfer_Sample_Result_Contract_document_original.pdf</contract-doc>\n <idfrontside>QES-BankTransfer_Sample_Result_idfrontside.jpg</idfrontside>\n <signedcontract-doc>QES-BankTransfer_Sample_Result_Contract_document_signed.pdf</signedcontract-doc>\n <security1>QES-BankTransfer_Sample_Result_security1.jpg</security1>\n <userface>QES-BankTransfer_Sample_Result_userface.jpg</userface>\n <securityfeaturevideo>QES-BankTransfer_Sample_Result_securityfeaturevideo.mp4</securityfeaturevideo>\n <security2>QES-BankTransfer_Sample_Result_security2.jpg</security2>\n <security3>QES-BankTransfer_Sample_Result_security3.jpg</security3>\n <signedcontract-demobanktransferqesonly_namirial_signature_contract>QES-BankTransfer_Sample_Result_demobanktransferqesonly_namirial_signature_contract_signed.pdf</signedcontract-demobanktransferqesonly_namirial_signature_contract>\n <pdf>QES-BankTransfer_Sample_Result.pdf</pdf>\n <contract-demobanktransferqesonly_namirial_signature_contract>QES-BankTransfer_Sample_Result_demobanktransferqesonly_namirial_signature_contract_original.pdf</contract-demobanktransferqesonly_namirial_signature_contract>\n </attachments>\n <banktransferpaymentinfo>\n <senderbankname>Testbank</senderbankname>\n <senderiban>DE62888888880012345678</senderiban>\n <amount>€0.01</amount>\n <paymentstatus>SUCCESS</paymentstatus>\n <senderholdername>MUSTERMANN, ERIKA</senderholdername>\n <paymentid>xp_zJK5oLdTY9Qfzyv3</paymentid>\n </banktransferpaymentinfo>\n </identification>\n</identifications>\n\nWhen using AutoIdent with Bank Transfer (GwG), the XML result will contain an additional block that will include the details and status of the bank transaction.
\n<banktransferpaymentinfo>\n <senderbankname>Testbank</senderbankname>\n <senderiban>DE62888888880012345678</senderiban>\n <amount>€0.01</amount>\n <paymentstatus>SUCCESS</paymentstatus>\n <senderholdername>MUSTERMANN, HARTMUT</senderholdername>\n <paymentid>xp_zJK5oLdTY9Qfzyv3</paymentid>\n</banktransferpaymentinfo>\n\nOn request, IDnow can provide a signature for the XML file to prove that
\nIn the ZIP file the signature has the filename .sig.
The public keys can be received from the following locations:
\nThe command to verify the signature of an XML file is as follows:
\nopenssl dgst -sha512 -verify .pem -signature .sig .xml Verified OK
The XML result will always start with the top-level Ident process information and will then have additional blocks containing custom data, contact data, user data, identification data, attachments and so on.
\n <identifications>\n <identification>\n <identificationprocess>\n <result>SUCCESS</result>\n <identificationtime>2014-06-02T05:03:54Z</identificationtime>\n <type>APP</type>\n <transactionnumber>AH73JK3LM</transactionnumber>\n <companyid>your_company</companyid>\n <id>IBA-H7GB6</id>\n </identificationprocess>\n <customdata>\n <custom1>2740332</custom1>\n <custom2>ABCD</custom2>\n </customdata>\n <contactdata>\n <email>hello@democompny.de</email>\n <mobilephone>+491778901234</mobilephone>\n </contactdata>\n <userdata>\n <firstname status=\"MATCH\">OLIVIA</firstname>\n <lastname status=\"MATCH\">JONES</lastname>\n <birthday status=\"CHANGE\" original=\"1982-05-22\">1983-05-22</birthday>\n <birthplace status=\"MATCH\">LONDON</birthplace>\n <nationality status=\"MATCH\">GB</nationality>\n <gender status=\"MATCH\">FEMALE</gender>\n <address class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <street status=\"MATCH\">BAKER STR.</street>\n <streetnumber status=\"MATCH\">40</streetnumber>\n <city status=\"MATCH\">LONDON</city>\n <country status=\"MATCH\">GB</country>\n <zipcode status=\"MATCH\">80469</zipcode>\n </address>\n </userdata>\n <identificationdocument>\n <type status=\"NEW\">IDCARD</type>\n <country status=\"NEW\">DE</country>\n <validuntil status=\"REDACTION\"/>\n <number status=\"REDACTION\"/>\n <issuedby status=\"NEW\">CITYLONDON, LONDON</issuedby>\n <dateissued status=\"NEW\">2012-03-27</dateissued>\n </identificationdocument>\n <attachments>\n <pdf>AH73JK3LM.pdf</pdf>\n <idfrontside>AH73JK3LM_idfrontside.jpg</idfrontside>\n <idbackside>AH73JK3LM_idbackside.jpg</idbackside>\n <userface>AH73JK3LM_userface.jpg</userface>\n <security1>AH73JK3LM_security1.jpg</security1>\n <security2>AH73JK3LM_security2.jpg</security2>\n <security3>AH73JK3LM_security3.jpg</security3>\n </attachments>\n </identification>\n </identifications>\n\nPlease note that the content of the XML file (especially the node ) varies depending on your configuration.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8c8a9dce-d0ac-4c78-8a63-f7ac952c88ea"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"808cc51c-212f-42fc-b4b4-046b697f6a58"}}],"_postman_id":"0104518b-a880-47a7-9511-5917b03f12bd"},{"name":"JSON Sample Responses","item":[],"id":"fa410d62-8220-48c0-953b-472b52394750","description":"The JSON result for an API call will always start with the top-level Ident process information and will then have additional blocks containing custom data, contact data, user data, identification data, attachments and so on.
\nPlease see examples below that show the JSON response for various Ident statuses.
\nWhen webhooks are sent to customers, the webhook body contains this same JSON response.
\n{\n \"identifications\": [\n {\n \"identificationprocess\": {\n \"result\": \"SUCCESS\",\n \"companyid\": \"demosecurityfeatures\",\n \"filename\": \"demosecurityfeatures__20190528_154257__061e65c8ad110.zip\",\n \"identificationtime\": \"2019-05-28T17:47:12+02:00\",\n \"id\": \"TST-SFYGG\",\n \"href\": \"/api/v1/demosecurityfeatures/identifications/demosecurityfeatures__20190528_154257__061e65c8ad110.zip\",\n \"type\": \"APP\",\n \"transactionnumber\": \"demosecurityfeatures_20190528\"\n \"wasnfcused\": \"true\"\n },\n \"customdata\": {\n \"custom3\": null,\n \"custom4\": null,\n \"custom1\": null,\n \"custom2\": null,\n \"custom5\": null\n },\n \"contactdata\": {\n \"mobilephone\": null,\n \"email\": null\n },\n \"userdata\": {\n \"birthday\": {\n \"status\": \"NEW\",\n \"value\": \"1977-04-27\"\n },\n \"firstname\": {\n \"status\": \"NEW\",\n \"value\": \"ERIKA\"\n },\n \"address\": {\n \"city\": {\n \"status\": \"NEW\",\n \"value\": \"POING\"\n },\n \"street\": {\n \"status\": \"NEW\",\n \"value\": \"WILHELM-HAUFF-STRAßE\"\n }\n },\n \"birthplace\": {\n \"status\": \"NEW\",\n \"value\": \"DRESDEN\"\n },\n \"nationality\": {\n \"status\": \"NEW\",\n \"value\": \"DE\"\n },\n \"identlanguage\": {\n \"status\": \"MATCH\",\n \"value\": \"en\"\n },\n \"title\": {\n \"status\": \"NEW\",\n \"value\": \"DR.\"\n },\n \"lastname\": {\n \"status\": \"NEW\",\n \"value\": \"MUSTERMANN\"\n }\n },\n \"identificationdocument\": {\n \"country\": {\n \"status\": \"NEW\",\n \"value\": \"DE\"\n },\n \"number\": {\n \"status\": \"NEW\",\n \"value\": \"LF3R8ZV44\"\n },\n \"issuedby\": {\n \"status\": \"NEW\",\n \"value\": \"NATIONAL AUTHORITY\"\n },\n \"dateissued\": {\n \"status\": \"NEW\",\n \"value\": \"2014-09-12\"\n },\n \"type\": {\n \"status\": \"NEW\",\n \"value\": \"IDCARD\"\n },\n \"validuntil\": {\n \"status\": \"NEW\",\n \"value\": \"2024-09-11\"\n }\n },\n \"attachments\": {\n \"pdf\": \"demosecurityfeatures_20190528.pdf\",\n \"xml\": \"demosecurityfeatures_20190528.xml\",\n \"security4\": \"demosecurityfeatures_20190528.jpg\",\n \"idbackside\": \"demosecurityfeatures_20190528_idbackside.jpg\",\n \"idfrontside\": \"demosecurityfeatures_2019052_idfrontside.jpg\",\n \"security1\": \"demosecurityfeatures_20190528_security1.jpg\",\n \"userface\": \"demosecurityfeatures_20190528_userface.jpg\",\n \"security2\": \"demosecurityfeatures_20190528_security2.jpg\",\n \"security3\": \"demosecurityfeatures_20190528_security3.jpg\"\n }\n },\n\nExample of an Ident process with a 2 documents. identificationdocument2 can just be of type DRIVERS_LICENSE
{\n \"identifications\": [\n {\n \"identificationprocess\": {\n \"result\": \"FRAUD_SUSPICION_PENDING\",\n \"companyid\": \"demosecurityfeatures\",\n \"filename\": \"demosecurityfeatures__20190528_154257__061e65c8ad110.zip\",\n \"identificationtime\": \"2019-05-28T17:47:12+02:00\",\n \"id\": \"TST-SFYGG\",\n \"href\": \"/api/v1/demosecurityfeatures/identifications/demosecurityfeatures__20190528_154257__061e65c8ad110.zip\",\n \"type\": \"APP\",\n \"transactionnumber\": \"demosecurityfeatures__20190528_154257__061e65c8ad110\"\n },\n \"customdata\": {\n \"custom3\": null,\n \"custom4\": null,\n \"custom1\": null,\n \"custom2\": null,\n \"custom5\": null\n },\n \"contactdata\": {\n \"mobilephone\": null,\n \"email\": null\n },\n \"userdata\": {\n \"birthday\": {\n \"status\": \"NEW\",\n \"value\": \"1977-04-27\"\n },\n \"firstname\": {\n \"status\": \"NEW\",\n \"value\": \"ERIKA\"\n },\n \"address\": {\n \"city\": {\n \"status\": \"NEW\",\n \"value\": \"POING\"\n },\n \"street\": {\n \"status\": \"NEW\",\n \"value\": \"WILHELM-HAUFF-STRAßE\"\n }\n },\n \"birthplace\": {\n \"status\": \"NEW\",\n \"value\": \"DRESDEN\"\n },\n \"nationality\": {\n \"status\": \"NEW\",\n \"value\": \"DE\"\n },\n \"identlanguage\": {\n \"status\": \"MATCH\",\n \"value\": \"en\"\n },\n \"title\": {\n \"status\": \"NEW\",\n \"value\": \"DR.\"\n },\n \"lastname\": {\n \"status\": \"NEW\",\n \"value\": \"MUSTERMANN\"\n }\n },\n \"identificationdocument\": {\n \"country\": {\n \"status\": \"NEW\",\n \"value\": \"DE\"\n },\n \"number\": {\n \"status\": \"NEW\",\n \"value\": \"LF3R8ZV44\"\n },\n \"issuedby\": {\n \"status\": \"NEW\",\n \"value\": \"NATIONAL AUTHORITY\"\n },\n \"dateissued\": {\n \"status\": \"NEW\",\n \"value\": \"2014-09-12\"\n },\n \"type\": {\n \"status\": \"NEW\",\n \"value\": \"IDCARD\"\n },\n \"validuntil\": {\n \"status\": \"NEW\",\n \"value\": \"2024-09-11\"\n }\n },\n \"identificationdocument2\": {\n \"birthday\": \"\",\n \"number\": \"\",\n \"country\": null,\n \"firstname\": Erika,\n \"driverlicenseclasses\": [],\n \"issuedby\": \"\",\n \"dateissued\": \"\",\n \"type\": \"DRIVERS_LICENSE\",\n \"validuntil\": \"\",\n \"lastname\": Mustermann\n },\n \"attachments\": {\n \"pdf\": \"demosecurityfeatures__20190528_154257__061e65c8ad110.pdf\",\n \"xml\": \"demosecurityfeatures__20190528_154257__061e65c8ad110.xml\",\n \"security4\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_security4.jpg\",\n \"idbackside\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_idbackside.jpg\",\n \"idfrontside\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_idfrontside.jpg\",\n \"security1\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_security1.jpg\",\n \"userface\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_userface.jpg\",\n \"security2\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_security2.jpg\",\n \"security3\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_security3.jpg\"\n }\n },\n\nA successful identification but some field values were corrected by an agent during review. Values that are changed are indicated by the value ot the \"status\" field as \"CHANGE\".
\n{\n \"identificationprocess\": {\n \"result\": \"SUCCESS_DATA_CHANGED\",\n \"companyid\": \"demosigningdatacapture\",\n \"filename\": \"2708202303.zip\",\n \"agentname\": \"TROBOT\",\n \"identificationtime\": \"2023-08-27T10:57:31+02:00\",\n \"id\": \"TST-WEEVV\",\n \"href\": \"/api/v1/demosigningdatacapture/identifications/2708202303.zip\",\n \"type\": \"APP\",\n \"transactionnumber\": \"2708202303\"\n },\n \"customdata\": {\n \"custom3\": \"Eg. Insurance number\",\n \"custom4\": \"or store any data strings\",\n \"custom1\": \"Eg. Employer name\",\n \"custom2\": \"Eg. Job Position \",\n \"custom5\": \"you like.\"\n },\n \"contactdata\": {\n \"mobilephone\": \"+491700009000\",\n \"email\": \"hello@democompany.org\"\n },\n \"userdata\": {\n \"birthday\": {\n \"status\": \"CHANGE\",\n \"original\": \"1987-05-23\"\n },\n \"firstname\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"ERIKA\"\n },\n \"address\": {\n \"zipcode\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"W1U\"\n },\n \"country\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"DE\"\n }\n },\n \"birthplace\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"LONDON\"\n },\n \"nationality\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"DE\"\n },\n \"gender\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"FEMALE\"\n },\n \"identlanguage\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"en\"\n },\n \"lastname\": {\n \"status\": \"CHANGE\",\n \"value\": \"JONES\",\n \"original\": \"MUSTERMAN\"\n }\n },\n \"identificationdocument\": {\n \"country\": {\n \"status\": \"NEW\",\n \"value\": \"DE\"\n },\n \"number\": {\n \"status\": \"NEW\",\n \"value\": \"P01X00T47\"\n },\n \"issuedby\": {\n \"status\": \"NEW\",\n \"value\": \"LHS MÜNCHEN,\"\n },\n \"dateissued\": {\n \"status\": \"NEW\",\n \"value\": \"2022-01-11\"\n },\n \"type\": {\n \"status\": \"NEW\",\n \"value\": \"IDCARD\"\n },\n \"validuntil\": {\n \"status\": \"NEW\",\n \"value\": \"2032-08-01\"\n }\n },\n \"attachments\": {\n \"pdf\": \"demodatacapture_2708202302.pdf\",\n \"xml\": \"demodatacapture_2708202302.xml\",\n \"idbackside\": \"demodatacapture_2708202302_idbackside.jpg\",\n \"idfrontside\": \"demodatacapture_2708202302_idfrontside.jpg\",\n \"security1\": \"demodatacapture_2708202302_security1.jpg\",\n \"userface\": \"demodatacapture_2708202302_userface.jpg\"\n }\n}\n\nReponse when the user has aborted the identification process in the app. When the user aborts the process, the response contains only \"Original\" values that were sent in the original request data during ident creation, and does not include any readout values from the document.
\n{\n \"identificationprocess\": {\n \"result\": \"ABORTED\",\n \"reason\": \"USER_CANCELLATION_IDENTIFY_LATER\",\n \"companyid\": \"demosigningdatacapture\",\n \"identificationtime\": null,\n \"id\": \"TST-FTNYB\",\n \"type\": \"APP\",\n \"transactionnumber\": \"270820231\"\n },\n \"customdata\": {\n \"custom3\": \"Eg. Insurance number\",\n \"custom4\": \"or store any data strings\",\n \"custom1\": \"Eg. Employer name\",\n \"custom2\": \"Eg. Job Position \",\n \"custom5\": \"you like.\"\n },\n \"contactdata\": {\n \"mobilephone\": \"+491700009000\",\n \"email\": \"hello@democompany.org\"\n },\n \"userdata\": {\n \"birthday\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"1987-05-23\"\n },\n \"firstname\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"ERIKA\"\n },\n \"address\": {\n \"zipcode\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"W1U\"\n },\n \"country\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"DE\"\n }\n },\n \"birthplace\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"LONDON\"\n },\n \"nationality\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"DE\"\n },\n \"gender\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"FEMALE\"\n },\n \"identlanguage\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"en\"\n },\n \"lastname\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"MUSTERMAN\"\n }\n },\n \"identificationdocument\": {},\n \"attachments\": {\n \"xmlsig\": \"270820231.xml.sig\",\n \"pdf\": \"270820231.pdf\",\n \"xml\": \"270820231.xml\"\n }\n}\n\nAn identification that has not been started by the user, will have no data in our backend and hence the response will be an OBJECT_NOT_FOUND, as no data was found related to the identification object.
{\n \"errors\": [\n {\n \"cause\": \"OBJECT_NOT_FOUND\",\n \"errorType\": null,\n \"id\": \"12669681\",\n \"key\": \"Ident TST-QJPCG - No identification request found matching the provided parameters\",\n \"message\": null,\n \"translationKey\": null\n }\n ]\n}\n\nAn identification that is waiting for an agent review. This is sent when the user has finished the process in the app but the ident is waiting for an agent review. The response contains both original user data sent during ident creation and the readout data, however, some of the readout data may be incorrect due to which the review was triggered.
\n{\n \"identificationprocess\": {\n \"result\": \"CHECK_PENDING\",\n \"companyid\": \"demodatacapture\",\n \"identificationtime\": \"2023-08-27T02:16:48+02:00\",\n \"id\": \"TST-QJPCG\",\n \"type\": \"APP\",\n \"transactionnumber\": \"2708202302\"\n },\n \"customdata\": {\n \"custom3\": \"Eg. Insurance number\",\n \"custom4\": \"or store any data strings\",\n \"custom1\": \"Eg. Employer name\",\n \"custom2\": \"Eg. Job Position \",\n \"custom5\": \"you like.\"\n },\n \"contactdata\": {\n \"mobilephone\": \"+491700009000\",\n \"email\": \"hello@democompany.org\"\n },\n \"userdata\": {\n \"birthday\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"1987-05-23\"\n },\n \"firstname\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"ERIKA\"\n },\n \"address\": {\n \"zipcode\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"W1U\"\n },\n \"country\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"DE\"\n }\n },\n \"birthplace\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"LONDON\"\n },\n \"nationality\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"DE\"\n },\n \"gender\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"FEMALE\"\n },\n \"identlanguage\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"en\"\n },\n \"lastname\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"MUSTERMAN\"\n }\n },\n \"identificationdocument\": {\n \"firstname\": {\n \"status\": \"MATCH\",\n \"original\": \"ERIKA\"\n },\n \"lastname\": {\n \"status\": \"MATCH\",\n \"original\": \"MUSTERMAN\"\n },\n \"country\": {\n \"status\": \"NEW\",\n \"value\": \"BE\"\n },\n \"issuedby\": {\n \"status\": \"NEW\",\n \"value\": \"NATIONAL AUTHORITY\"\n },\n \"dateissued\": {\n \"status\": \"NEW\",\n \"value\": \"2015-08-26\"\n },\n \"type\": {\n \"status\": \"NEW\",\n \"value\": \"IDCARD\"\n }\n },\n \"attachments\": {\n \"pdf\": \"demodatacapture_2708202302.pdf\",\n \"xml\": \"demodatacapture_2708202302.xml\",\n \"idbackside\": \"demodatacapture_2708202302_idbackside.jpg\",\n \"idfrontside\": \"demodatacapture_2708202302_idfrontside.jpg\",\n \"security1\": \"demodatacapture_2708202302_security1.jpg\",\n \"userface\": \"demodatacapture_2708202302_userface.jpg\"\n }\n}\n\n{\n \"identificationprocess\": {\n \"result\": \"CANCELED\",\n \"reason\": \"ID_EXPIRED\",\n \"companyid\": \"demodatacapture\",\n \"identificationtime\": \"2023-08-31T01:40:12+02:00\",\n \"id\": \"TST-HNQUM\",\n \"type\": \"APP\",\n \"transactionnumber\": \"3008202305\"\n },\n \"customdata\": {\n \"custom3\": \"Eg. Insurance number\",\n \"custom4\": \"or store any data strings\",\n \"custom1\": \"Eg. Employer name\",\n \"custom2\": \"Eg.\",\n \"custom5\": \"you like.\"\n },\n \"contactdata\": {\n \"mobilephone\": \"+4917636109660\",\n \"email\": \"hello@democompany.org\"\n },\n \"userdata\": {\n \"birthday\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"1987-05-23\"\n },\n \"firstname\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"ERIKA\"\n },\n \"address\": {\n \"zipcode\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"W1U\"\n },\n \"country\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"DE\"\n }\n },\n \"birthplace\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"LONDON\"\n },\n \"nationality\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"DE\"\n },\n \"gender\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"FEMALE\"\n },\n \"identlanguage\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"en\"\n },\n \"birthname\": {\n \"status\": \"NEW\",\n \"value\": \"GABLER\"\n },\n \"lastname\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"MUSTERMAN\"\n }\n },\n \"identificationdocument\": {\n \"country\": {\n \"status\": \"NEW\",\n \"value\": \"DE\"\n },\n \"number\": {\n \"status\": \"NEW\",\n \"value\": \"L01X00T47\"\n },\n \"issuedby\": {\n \"status\": \"NEW\",\n \"value\": \"NATIONAL AUTHORITY\"\n },\n \"dateissued\": {\n \"status\": \"NEW\",\n \"value\": \"2017-01-11\"\n },\n \"type\": {\n \"status\": \"NEW\",\n \"value\": \"IDCARD\"\n },\n \"validuntil\": {\n \"status\": \"NEW\",\n \"value\": \"2031-08-01\"\n }\n },\n \"attachments\": {\n \"pdf\": \"3008202305.pdf\",\n \"userface\": \"3008202305_userface.jpg\"\n \"xml\": \"3008202305.xml\",\n \"idfrontside\": \"3008202305_idfrontside.jpg\",\n \"idbackside\": \"3008202305_idbackside.jpg\"\n }\n}\n\n{\n \"identifications\": [\n {\n \"identificationprocess\": {\n \"result\": \"FRAUD_SUSPICION_PENDING\",\n \"companyid\": \"demosecurityfeatures\",\n \"filename\": \"demosecurityfeatures__20190528_154257__061e65c8ad110.zip\",\n \"identificationtime\": \"2019-05-28T17:47:12+02:00\",\n \"id\": \"TST-SFYGG\",\n \"href\": \"/api/v1/demosecurityfeatures/identifications/demosecurityfeatures__20190528_154257__061e65c8ad110.zip\",\n \"type\": \"APP\",\n \"transactionnumber\": \"demosecurityfeatures__20190528_154257__061e65c8ad110\"\n },\n \"customdata\": {\n \"custom3\": null,\n \"custom4\": null,\n \"custom1\": null,\n \"custom2\": null,\n \"custom5\": null\n },\n \"contactdata\": {\n \"mobilephone\": null,\n \"email\": null\n },\n \"userdata\": {\n \"birthday\": {\n \"status\": \"NEW\",\n \"value\": \"1977-04-27\"\n },\n \"firstname\": {\n \"status\": \"NEW\",\n \"value\": \"ERIKA\"\n },\n \"address\": {\n \"city\": {\n \"status\": \"NEW\",\n \"value\": \"POING\"\n },\n \"street\": {\n \"status\": \"NEW\",\n \"value\": \"WILHELM-HAUFF-STRAßE\"\n }\n },\n \"birthplace\": {\n \"status\": \"NEW\",\n \"value\": \"DRESDEN\"\n },\n \"nationality\": {\n \"status\": \"NEW\",\n \"value\": \"DE\"\n },\n \"identlanguage\": {\n \"status\": \"MATCH\",\n \"value\": \"en\"\n },\n \"title\": {\n \"status\": \"NEW\",\n \"value\": \"DR.\"\n },\n \"lastname\": {\n \"status\": \"NEW\",\n \"value\": \"MUSTERMANN\"\n }\n },\n \"identificationdocument\": {\n \"country\": {\n \"status\": \"NEW\",\n \"value\": \"DE\"\n },\n \"number\": {\n \"status\": \"NEW\",\n \"value\": \"LF3R8ZV44\"\n },\n \"issuedby\": {\n \"status\": \"NEW\",\n \"value\": \"NATIONAL AUTHORITY\"\n },\n \"dateissued\": {\n \"status\": \"NEW\",\n \"value\": \"2014-09-12\"\n },\n \"type\": {\n \"status\": \"NEW\",\n \"value\": \"IDCARD\"\n },\n \"validuntil\": {\n \"status\": \"NEW\",\n \"value\": \"2024-09-11\"\n }\n },\n \"identificationdocument2\": {\n \"birthday\": \"\",\n \"number\": \"\",\n \"country\": null,\n \"firstname\": Erika,\n \"driverlicenseclasses\": [],\n \"issuedby\": \"\",\n \"dateissued\": \"\",\n \"type\": \"DRIVERS_LICENSE\",\n \"validuntil\": \"\",\n \"lastname\": Mustermann\n },\n \"attachments\": {\n \"pdf\": \"demosecurityfeatures__20190528_154257__061e65c8ad110.pdf\",\n \"xml\": \"demosecurityfeatures__20190528_154257__061e65c8ad110.xml\",\n \"security4\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_security4.jpg\",\n \"idbackside\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_idbackside.jpg\",\n \"idfrontside\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_idfrontside.jpg\",\n \"security1\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_security1.jpg\",\n \"userface\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_userface.jpg\",\n \"security2\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_security2.jpg\",\n \"security3\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_security3.jpg\"\n }\n },\n\n{\n \"identifications\": [\n {\n \"identificationprocess\": {\n \"result\": \"FRAUD_SUSPICION_CONFIRMED\",\n \"reason\": \"WARNING_MANIPULATED_DATA\"\n \"companyid\": \"demosecurityfeatures\",\n \"filename\": \"demosecurityfeatures__20190528_154257__061e65c8ad110.zip\",\n \"identificationtime\": \"2019-05-28T17:47:12+02:00\",\n \"id\": \"TST-SFYGG\",\n \"href\": \"/api/v1/demosecurityfeatures/identifications/demosecurityfeatures__20190528_154257__061e65c8ad110.zip\",\n \"type\": \"APP\",\n \"transactionnumber\": \"demosecurityfeatures__20190528_154257__061e65c8ad110\"\n },\n \"customdata\": {\n \"custom3\": null,\n \"custom4\": null,\n \"custom1\": null,\n \"custom2\": null,\n \"custom5\": null\n },\n \"contactdata\": {\n \"mobilephone\": null,\n \"email\": null\n },\n \"userdata\": {\n \"birthday\": {\n \"status\": \"NEW\",\n \"value\": \"1977-04-27\"\n },\n \"firstname\": {\n \"status\": \"NEW\",\n \"value\": \"ERIKA\"\n },\n \"address\": {\n \"city\": {\n \"status\": \"NEW\",\n \"value\": \"POING\"\n },\n \"street\": {\n \"status\": \"NEW\",\n \"value\": \"WILHELM-HAUFF-STRAßE\"\n }\n },\n \"birthplace\": {\n \"status\": \"NEW\",\n \"value\": \"DRESDEN\"\n },\n \"nationality\": {\n \"status\": \"NEW\",\n \"value\": \"DE\"\n },\n \"identlanguage\": {\n \"status\": \"MATCH\",\n \"value\": \"en\"\n },\n \"title\": {\n \"status\": \"NEW\",\n \"value\": \"DR.\"\n },\n \"lastname\": {\n \"status\": \"NEW\",\n \"value\": \"MUSTERMANN\"\n }\n },\n \"identificationdocument\": {\n \"country\": {\n \"status\": \"NEW\",\n \"value\": \"DE\"\n },\n \"number\": {\n \"status\": \"NEW\",\n \"value\": \"LF3R8ZV44\"\n },\n \"issuedby\": {\n \"status\": \"NEW\",\n \"value\": \"NATIONAL AUTHORITY\"\n },\n \"dateissued\": {\n \"status\": \"NEW\",\n \"value\": \"2014-09-12\"\n },\n \"type\": {\n \"status\": \"NEW\",\n \"value\": \"IDCARD\"\n },\n \"validuntil\": {\n \"status\": \"NEW\",\n \"value\": \"2024-09-11\"\n }\n },\n \"attachments\": {\n \"pdf\": \"demosecurityfeatures__20190528_154257__061e65c8ad110.pdf\",\n \"xml\": \"demosecurityfeatures__20190528_154257__061e65c8ad110.xml\",\n \"security4\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_security4.jpg\",\n \"idbackside\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_idbackside.jpg\",\n \"idfrontside\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_idfrontside.jpg\",\n \"security1\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_security1.jpg\",\n \"userface\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_userface.jpg\",\n \"security2\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_security2.jpg\",\n \"security3\": \"demosecurityfeatures__20190528_154257__061e65c8ad110_security3.jpg\"\n }\n },\n\n{\n \"identificationprocess\": {\n \"result\": \"SUCCESS_DATA_CHANGED\",\n \"companyid\": \"demoproofofaddress\",\n \"poaresult\": \"SUCCESS\",\n \"filename\": \"20250206.zip\",\n \"agentname\": \"TROBOT\",\n \"identificationtime\": \"2025-02-07T11:43:41+01:00\",\n \"id\": \"TS2-LKRHL\",\n \"href\": \"/api/v1/demoproofofaddress/identifications/20250206.zip\",\n \"type\": \"APP\",\n \"transactionnumber\": \"20250206\"\n },\n \"customdata\": {\n \"custom3\": \"Eg. Insurance number\",\n \"custom4\": \"or store any data strings\",\n \"custom1\": \"Eg. Employer name\",\n \"custom2\": \"Eg. Job Position \",\n \"custom5\": \"you like.\"\n },\n \"contactdata\": {\n \"mobilephone\": \"+441753109660\",\n \"email\": \"hello@democompany.org\"\n },\n \"userdata\": {\n \"birthday\": {\n \"status\": \"CHANGE\",\n \"value\": \"1964-08-12\",\n \"original\": \"1987-05-23\"\n },\n \"firstname\": {\n \"status\": \"MATCH\",\n \"value\": \"ERIKA\"\n },\n \"address\": {\n \"zipcode\": {\n \"status\": \"ORIGINAL\",\n \"value\": \"80469\"\n },\n \"country\": {\n \"status\": \"ORIGINAL\",\n \"value\": \"DE\"\n },\n \"city\": {\n \"status\": \"MATCH\",\n \"value\": \"MUNICH\"\n },\n \"street\": {\n \"status\": \"ORIGINAL\",\n \"value\": \"HIGH STREET\"\n },\n \"streetnumber\": {\n \"status\": \"ORIGINAL\",\n \"value\": \"100\"\n }\n },\n \"nationality\": {\n \"status\": \"CHANGE\",\n \"value\": \"DE\",\n \"original\": \"GB\"\n },\n \"gender\": {\n \"status\": \"MATCH\",\n \"value\": \"FEMALE\"\n },\n \"lastname\": {\n \"status\": \"CHANGE\",\n \"value\": \"MUSTERMANN\",\n \"original\": \"MUSTERMAN\"\n }\n },\n \"identificationdocument\": {\n \"country\": {\n \"status\": \"NEW\",\n \"value\": \"DE\"\n },\n \"number\": {\n \"status\": \"NEW\",\n \"value\": \"C01X00T47\"\n },\n \"validuntil\": {\n \"status\": \"NEW\",\n \"value\": \"2027-02-28\"\n }\n },\n \"attachments\": {\n \"pdf\": \"20250206.pdf\",\n \"bankstatement\": \"20250206_signature.jpg\",\n \"utilitybill\": \"20250206_utilitybill.jpg\",\n \"xml\": \"20250206.xml\",\n \"idfrontside\": \"20250206_idfrontside.jpg\"\n },\n \"additionaldocuments\": [\n {\n \"documentname\": \"UTILITY_BILL\",\n \"address\": {\n \"zipcode\": {\n \"status\": \"MATCH\",\n \"value\": \"80469\"\n },\n \"country\": {\n \"status\": \"MATCH\",\n \"value\": \"DE\"\n },\n \"city\": {\n \"status\": \"MATCH\",\n \"value\": \"MUNICH\"\n },\n \"street\": {\n \"status\": \"MATCH\",\n \"value\": \"HIGH STREET\"\n },\n \"streetnumber\": {\n \"status\": \"MATCH\",\n \"value\": \"100\"\n }\n }\n }\n ]\n}\n\n(REQUIRED) Your private Auth Token
\n","key":"X-API-LOGIN-TOKEN","type":"text","value":"{{LOGIN-TOKEN}}"},{"description":"(REQUIRED) The media type
\n","key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"/api/v1//identifications/ OR ","description":"Retrieves data for a single Ident.
\nBesides the core data of the user, the result contains information about the verification in the object identificationprocess.
The result also contains information about the available attached contents of an Ident in the object attachments {}.
(REQUIRED) Your private Auth Token
\n","key":"X-API-LOGIN-TOKEN","type":"text","value":"{{LOGIN-TOKEN}}"},{"description":"(REQUIRED) The media type
\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"/api/v1//identifications/.pdf","description":"Results in one file where the user data is printed in a formatted PDF.
\nNote: To get the actual PDF, add filename extension .pdf at the end of the request.
(REQUIRED) Your private Auth Token
\n","key":"X-API-LOGIN-TOKEN","type":"text","value":"{{LOGIN-TOKEN}}"},{"description":"(REQUIRED) The media type
\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"/api/v1//identifications/.zip","description":"Returns a zip file containing all available data attachments of this Ident.
\nThe relative path to this zip file is shown in the field hrefof the JSON response object.
Note1: To get the actual zip file, add filename extension .zip following the transactionnumber at the end of the request.
Note2: It is currently not possible to directly fetch the other files within the zip file via the API. There is no way to directly download the jpg files contained in the zip. The suggested approach is to download the zip and extract the required files from it.
\n","urlObject":{"path":["api","v1","","identifications",".zip"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"3dcaf79b-450e-4978-931d-10fae7f018c7","name":"Get ZIP Ident 200","originalRequest":{"method":"GET","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}"},{"key":"Content-Type","value":"application/json"}],"url":"/api/v1//identifications/demosecurityfeatures__20190524_162939__d1694e9228b40.zip"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin,Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"591"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Wed, 05 Jun 2019 13:03:37 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"identificationprocess\": {\n \"result\": \"FRAUD_SUSPICION_PENDING\",\n \"companyid\": \"demosecurityfeatures\",\n \"filename\": \"demosecurityfeatures__20190524_162939__d1694e9228b40.zip\",\n \"identificationtime\": \"2019-05-24T18:33:30+02:00\",\n \"id\": \"TST-RVPZV\",\n \"href\": \"/api/v1/demosecurityfeatures/identifications/demosecurityfeatures__20190524_162939__d1694e9228b40.zip\",\n \"type\": \"APP\",\n \"transactionnumber\": \"demosecurityfeatures__20190524_162939__d1694e9228b40\"\n },\n \"customdata\": {\n \"custom3\": null,\n \"custom4\": null,\n \"custom1\": null,\n \"custom2\": null,\n \"custom5\": null\n },\n \"contactdata\": {\n \"mobilephone\": null,\n \"email\": null\n },\n \"userdata\": {\n \"address\": {},\n \"identlanguage\": {\n \"status\": \"MATCH\",\n \"value\": \"en\"\n }\n },\n \"identificationdocument\": {\n \"country\": {\n \"status\": \"NEW\",\n \"value\": \"BE\"\n },\n \"issuedby\": {\n \"status\": \"NEW\",\n \"value\": \"MOFIIETEAD=RAUITI-RONNE 15 AVR 13/90 NATIONALITÉ / NATIONALITY AUTONITÉ / AUTHONTY ~ ’ OBSERVATIONS / REMARKS\"\n },\n \"dateissued\": {\n \"status\": \"NEW\",\n \"value\": \"2015-08-26\"\n },\n \"type\": {\n \"status\": \"NEW\",\n \"value\": \"IDCARD\"\n }\n },\n \"attachments\": {\n \"pdf\": \"demosecurityfeatures__20190524_162939__d1694e9228b40.pdf\",\n \"xml\": \"demosecurityfeatures__20190524_162939__d1694e9228b40.xml\",\n \"idbackside\": \"demosecurityfeatures__20190524_162939__d1694e9228b40_idbackside.jpg\",\n \"idfrontside\": \"demosecurityfeatures__20190524_162939__d1694e9228b40_idfrontside.jpg\",\n \"security1\": \"demosecurityfeatures__20190524_162939__d1694e9228b40_security1.jpg\",\n \"userface\": \"demosecurityfeatures__20190524_162939__d1694e9228b40_userface.jpg\"\n }\n}"}],"_postman_id":"77230eb7-04d4-4ae1-a63d-818e697f4840"},{"name":"Get XML","id":"b1bf3386-375b-4038-b133-7e9b4312b218","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"(REQUIRED) Your private Auth Token
\n","key":"X-API-LOGIN-TOKEN","type":"text","value":"{{LOGIN-TOKEN}}"},{"description":"(REQUIRED) The media type
\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"/api/v1//identifications/.xml","description":"Can be used to directly fetch the XML result file of the Ident.
\nNote: To get the file, add the extension .xml at the end of the request.
(REQUIRED) Your private Auth Token
\n"},{"key":"Content-Type","value":"application/json","description":"(REQUIRED) The media type
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"birthday\":\"1987-05-23\",\n \"birthplace\":\"London\",\n \"custom1\": \"Eg. Employer name\",\n \"custom2\": \"Eg. Job Position \",\n \"custom3\": \"Eg. Insurance number\",\n \"custom4\":\"or store any data strings\",\n \"custom5\":\"you like.\",\n \"email\":\"hello@democompany.org\",\n \"firstname\":\"Erika\",\n \"gender\":\"FEMALE\",\n \"lastname\":\"Musterman\",\n \"mobilephone\":\"+49175310960\",\n \"nationality\":\"DE\",\n \"zipcode\":\"80469\",\n \"country\":\"DE\",\n \"city\":\"Munich\",\n \"street\":\"High Street\",\n \"streetnumber\":\"100\"\n}"},"url":"T}/api/v1//identifications//start","description":"Creates a single Ident.
\nThe has to be a new unique identifier to be used for this Ident.
Returns status code 201 and an id if the Ident has been created successfully.
Status code 200 indicates that an existing Ident with this transactionnumber has been successfully updated with the new values provided.
Note: To create an Ident for AutoIdent QES/eSign, please see the section under AutoIdent with QES/eSign.
\n","urlObject":{"path":["api","v1","","identifications","","start"],"host":["T}"],"query":[],"variable":[]}},"response":[{"id":"e440492a-0645-43dc-aa47-722e6318314b","name":"Create Ident 401","originalRequest":{"method":"POST","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"**(REQUIRED)** Your private Auth Token"},{"key":"Content-Type","value":"application/json","description":"**(REQUIRED)** The media type","type":"text"}],"body":{"mode":"raw","raw":"{\n \"birthday\": \"1987-05-23\",\n \"birthplace\": \"London\",\n \"city\": \"London\",\n \"country\": \"GB\",\n \"custom1\": \"\",\n \"custom2\": \"Custom fields\",\n \"custom3\": \"can set testbot scenarios\",\n \"custom4\": \"or store any data strings\",\n \"custom5\": \"you like.\",\n \"email\": \"hello@democompany.org\",\n \"firstname\": \"ERIKA\",\n \"gender\": \"FEMALE\",\n \"lastname\": \"MUSTERMANN\",\n \"mobilephone\": \"01789012345\",\n \"nationality\": \"GB\",\n \"street\": \"Baker Street\",\n \"zipcode\": \"W1U\"\n}"},"url":"/api/v1//identifications/demo-transactionxxnbr1/start"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"125"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Wed, 05 Jun 2019 13:37:35 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"cause\": \"INVALID_LOGIN_TOKEN\",\n \"errorType\": null,\n \"id\": \"69079771\",\n \"key\": null,\n \"message\": null,\n \"translationKey\": null\n }\n ]\n}"},{"id":"0444cbda-af1f-4a70-b057-8ad0548e55d8","name":"Create Ident 201","originalRequest":{"method":"POST","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"**(REQUIRED)** Your private Auth Token"},{"key":"Content-Type","value":"application/json","description":"**(REQUIRED)** The media type","type":"text"}],"body":{"mode":"raw","raw":"{\n \"birthday\":\"1987-05-23\",\n \"birthplace\":\"London\",\n \"custom1\": \"Eg. Employer name\",\n \"custom2\": \"Eg. Job Position \",\n \"custom3\": \"Eg. Insurance number\",\n \"custom4\":\"or store any data strings\",\n \"custom5\":\"you like.\",\n \"email\":\"hello@democompany.org\",\n \"firstname\":\"Erika\",\n \"gender\":\"FEMALE\",\n \"lastname\":\"Musterman\",\n \"mobilephone\":\"+49175310960\",\n \"nationality\":\"DE\",\n \"zipcode\":\"80469\",\n \"country\":\"DE\",\n \"city\":\"Munich\",\n \"street\":\"High Street\",\n \"streetnumber\":\"100\"\n}"},"url":"/api/v1//identifications/demo-transactionxxnbr2/start"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin,Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"38"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Thu, 06 Jun 2019 06:30:51 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"TST-SYDYA\"\n}"}],"_postman_id":"c0284ab2-bda3-49b0-b2e8-6f78adb228ad"},{"name":"Delete Ident","id":"d95d943c-c8b1-4408-840d-86c969674a4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"(REQUIRED) Your private Auth Token
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"/api/v1//identifications/","description":"Deletes a single Ident.
\nYou will receive status code 200 with an empty response body.
Note: The transactionnumber that was used when creating this Ident, cannot be reused to create a new Ident.
(REQUIRED) Your private Auth Token
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(REQUIRED) The media type
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"target_companyid\":\"democompany\",\n \"target_transactionnumber\":\"democompany2\"\n}"},"url":"/api/v1//identifications//copy","description":"Copies an existing Ident.
\nYour account needs permissions to copy data to a different account. If the permission is not enabled or you copy to an account with insufficient permissions, you will get a 403 FORBIDDEN. Contact acm@idnow.de if you want to set this up.
\n","urlObject":{"path":["api","v1","","identifications","","copy"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"fc34a983-f7db-4b03-96e2-d5c8ff9a73e2","name":"Copy Ident 401","originalRequest":{"method":"POST","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"target_companyid\":\"democompany\",\n \"target_transactionnumber\":\"democompany2\"\n}"},"url":"/api/v1/{{COMPANYID}}/identifications/demo-transactionxxnbr1/copy"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"125"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Wed, 05 Jun 2019 08:10:42 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"cause\": \"INVALID_LOGIN_TOKEN\",\n \"errorType\": null,\n \"id\": \"50897084\",\n \"key\": null,\n \"message\": null,\n \"translationKey\": null\n }\n ]\n}"},{"id":"fe413186-91ac-44e3-8916-bb46d371a828","name":"Copy Ident 404","originalRequest":{"method":"POST","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"**(REQUIRED)** Your private Auth Token","type":"text"},{"key":"Content-Type","value":"application/json","description":"**(REQUIRED)** The media type","type":"text"}],"body":{"mode":"raw","raw":"{\n \"target_companyid\":\"democompany\",\n \"target_transactionnumber\":\"democompany2\"\n}"},"url":"/api/v1//identifications/abc/copy"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"126"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Wed, 05 Jun 2019 13:07:10 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"cause\": \"OBJECT_NOT_FOUND\",\n \"errorType\": null,\n \"id\": \"18552384\",\n \"key\": \"token\",\n \"message\": \"abc\",\n \"translationKey\": null\n }\n ]\n}"}],"_postman_id":"8e478c7c-04fa-4e6b-9bd7-8e963d8a8517"},{"name":"Archive Ident","id":"566877e2-55a0-49a9-ba78-3f9ff92126a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"(REQUIRED) Your private Auth Token
\n","key":"X-API-LOGIN-TOKEN","type":"text","value":"{{LOGIN-TOKEN}}"}],"body":{"mode":"raw","raw":""},"url":"/api/v1//identifications//archive","description":"Archives an existing Ident. Does not work if the Ident is already archived or deleted.
\nPlease contact IDnow to enable this feature.
\n","urlObject":{"path":["api","v1","","identifications","","archive"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"748f3d01-2d1c-48b2-bdf1-075116d49019","name":"Archive Ident 401","originalRequest":{"method":"POST","header":[{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}"}],"body":{"mode":"raw","raw":""},"url":"/api/v1/{{COMPANYID}}/identifications/demo-transactionxxnbr1/archive"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"125"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Wed, 05 Jun 2019 08:10:55 GMT"},{"key":"Strict-Transport-Security","value":"max-age=15768000;"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"cause\": \"INVALID_LOGIN_TOKEN\",\n \"errorType\": null,\n \"id\": \"30989454\",\n \"key\": null,\n \"message\": null,\n \"translationKey\": null\n }\n ]\n}"}],"_postman_id":"566877e2-55a0-49a9-ba78-3f9ff92126a4"}],"id":"471d2aae-6260-4d24-9eb9-78f77b9548b8","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"7c8b7323-8d76-46c4-b588-c918cf4edda6"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"62a4a9e7-0c75-4206-9f31-5992d2e4ae07"}}],"_postman_id":"471d2aae-6260-4d24-9eb9-78f77b9548b8","description":""},{"name":"Other Features, Data Tables & Alternative Methods","item":[{"name":"System Health Check / Monitoring","item":[{"name":"Polling Frequency","item":[],"id":"8f0f4128-a537-49d0-a2e3-0b8cabedc9be","description":"This endpoint may be called every 5 minutes.
\n","_postman_id":"8f0f4128-a537-49d0-a2e3-0b8cabedc9be"}],"id":"25687d1a-e7ba-4a9d-98da-d6209e16557b","description":"The IDnow system provides an endpoint which can be used to monitor the system availability.
\nAn HTTP GET request to the following URL will execute the system check:
\nNote that the hostname in the below call can be changed to a different region and environment as needed. Please see IDnow Onboarding section for hostnames of different regions.
\nTest
\n curl -i https://gateway.test.idnow.de/system_check\n\nLive
\n curl -i https://gateway.idnow.de/system_check\n\nIn case the HTTP response code is HTTP 200 and the HTTP body is SYSTEM_CHECK_OK, the system is operational. Any other result indicates an issue with the system.
There are different types of webhooks that can be sent at different stages of the Ident flow:
\nExample Scenario:
\nYour account has the REALTIME webhook enabled.
User tries to complete the verification process in the app and quits the app flow, since the internet connection is not good enough. You will receive the ABORTED webhook for this aborted Ident.
User tries again and completes the Ident process in the app. You will receive a REALTIME webhook right after the user's in-app process is complete with the status CHECK_PENDING.
IDnow's Ident Specialist finishes the review and you receive the FINAL webhook with the final result.
IDnow informs you about the status of an identification via the FINAL webhook call so that you can automatically trigger an API call to download the identification’s result files.
\n","_postman_id":"051b3a19-e511-49fb-ae91-bf9ac3cb7231"},{"name":"Authentication","item":[],"id":"5d9cc1a5-5506-47c6-817d-6eeee6a50a11","description":"Basic authentication using a username and password is supported for Webhooks. Please contact your technical account manager at IDnow for help with setting up the authentication for webhooks.
\n","_postman_id":"5d9cc1a5-5506-47c6-817d-6eeee6a50a11"},{"name":"IP Addresses","item":[],"id":"870444b6-6dd7-4754-80a2-b70fbef327b3","description":"Webhooks will be sent from the following source IPs:
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"c6a04a01-0d55-45a8-af3c-c4dc2265892a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"65c7915a-da2b-4404-bf8c-3ed6b9ce4074"}}],"_postman_id":"870444b6-6dd7-4754-80a2-b70fbef327b3"},{"name":"Real-time/Final Webhooks","item":[],"id":"748d9534-5312-43ec-9cbf-5a1e18e8f95c","description":"The JSON of the identification is passed in the body of the call to the webhook:
\n {\n \"identificationprocess\": {\n ...rest of JSON...\n }, \"customdata\": {\n ...rest of JSON...\n },\n ...rest of JSON...\n }\n\nThe JSON structure is similar to the JSON from successful webhooks
\nThe differences are as follows:
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"58191b84-4da3-4c50-8cad-8d2cc4a7b6e1"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a2c4977e-e55c-41c3-8bd5-7f6fb0cbd88e"}}],"_postman_id":"a5971ba8-01de-4003-afb3-0a200217f50e"},{"name":"JSON Content in Webhooks","item":[],"id":"e3b3619c-c906-4ebe-b666-a5c679dc3e69","description":"The JSON data of the Ident is passed in the body of the webhook.
\nThe content of the webhook is identical to what you would receive when you call the GET Ident API endpoint. Please see the section 'JSON Sample Responses' for examples of JSON responses for an Ident in various states.
{\n \"identificationprocess\": {\n \"result\": \"CANCELED\",\n \"reason\": \"DATA_APPLICATION_DATA\",\n \"companyid\": \"democompany\",\n \"identificationtime\": \"2015-10-20T17:40:37+02:00\",\n \"id\": \"XKH-UNGNP\",\n \"type\": \"WEB\",\n \"transactionnumber\": \"IDN-x-83176070\"\n },\n \"customdata\": {\n ... rest of JSON ...\n },\n \"contactdata\": {\n ... rest of JSON ...\n },\n \"userdata\": {\n \"birthday\": {\n \"status\": \"ORIGINAL\",\n \"original\": \"2005-10-13\"\n ... attribute \"value\" not included ...\n }\n ... rest of JSON ...\n }\n ... attachments section not included ...\n ... identificationdocument section not included ... \n }\n\nIDnow informs you about aborted and canceled identifications so that you can track the progress of the user and inform the user to redo the identification.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"93c7edbb-bf01-4bf0-8f57-3e67ba5531c5"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"71a2f947-508a-4b7f-ad4c-07497687683c"}}],"_postman_id":"e3b3619c-c906-4ebe-b666-a5c679dc3e69"}],"id":"70186050-131a-4d53-abf7-9c0e5cfe1d0c","description":"When this feature is activated for your account, after each identification a callback to an endpoint URL on your servers will be executed by the IDnow system. The content of the webhook is identical to what you would receive when you call the GET Ident API endpoint.
To activate the feature please contact your technical account manager at IDnow.
\n","_postman_id":"70186050-131a-4d53-abf7-9c0e5cfe1d0c"},{"name":"Webhook Retry Support","item":[{"name":"Warn/Error E-Mails","item":[],"id":"9522097b-b92a-46bc-b0e1-f9d1e326deed","description":"If a webhook fails, you will first receive an e-mail with the following subject:
\n IDnow Webhook Warning: Unable to send for <transactionnumber>. Retrying.\n\nIf the webhook continues to fail and the maximum retry time is reached, you will receive the following email:
\n IDnow Webhook Error: Unable to send for <transactionnumber>. Giving up.\n\nThe recipient of the e-mail is the technical contact as defined during account setup.
\n","_postman_id":"9522097b-b92a-46bc-b0e1-f9d1e326deed"}],"id":"53ebb5fa-f578-49d5-ab9d-3668d71315f8","description":"Webhooks will be automatically retried if they are not successful. In addition, we will warn you if a webhook is not delivered successfully.
These are the default values used by IDnow. Please note that these can be changed for you by IDnow Account Management.
To select a test scenario, you can either set the firstname, lastname or any one of the custom1 to custom5 fields to a special setting {prefix}-{test scenario}
Five custom fields are available in the Create Ident request. These fields are optional and can be used to supply any custom information from your side as required. The values of custom fields sent during Ident creation will be simply relayed back to you in the Ident result files, webhooks and API responses.
Available prefixes are as follows:
\nThe available test scenarios are as follows:
\nSince these tests are only simulations, the Test Robot will always return a static set of sample data values in the result. The original data sent in the Ident request and the values read out from the document do not matter here - In the final results, the readout data will be replaced by values from our sample data set for the purposes of these tests.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"90e5824e-0f34-49bb-9636-49af164ff7a9"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"f73285bb-bcd6-4da0-a60c-d60ce12938c1"}}],"_postman_id":"dc1d2707-f41e-40aa-b87f-ea5f9df84541"},{"name":"Manual Test","item":[],"id":"5ca4004c-8357-42c1-9062-02d5cff6fb59","description":"A manual test means that you can use the frontend or apps of IDnow yourself, but the agent review part is automated. To perform a manual test, create a new identification using the REST API or using the 'user data' form. Please select one of the test scenarios from above and set the firstname, lastname or one of the custom fields accordingly to the {prefix}-{test scenario}.
The prefix to use is \"X-MANUALTEST\". This is an example for performing a fraud test:
firstname: \"X-MANUALTEST-FRAUDIDENT\"\n\nAfter creating the ident, open the Autoident app or web app and enter the IdentID and perform the steps. After the ident process is completed in the app, the Autoident Test Robot will start processing the ident. It may take about 1-2 minutes to process the ident by the robot. Once it is processed, you will be able to retrive the results via the API using the GET IDENT endpoint.
You can request a test with an IDnow agent on the test environment. Please contact your account representative or support@idnow.io for arranging a testing time slot. An IDnow agent will be available for you on the test environment.
\nPlease note: Since we have to use our agents for this form of testing, we have to charge hourly rates for such test sessions.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"fe349dd2-3439-4ab8-829a-1bdb9d128b43"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"53f71000-6918-4b50-b85b-6beae69fc4ce"}}],"_postman_id":"b3176fa9-a3f9-434e-89bf-1eb22d85f64b"},{"name":"Checking the Results","item":[],"id":"70e0aff6-82d9-4e4b-9d71-dbbbbc889d00","description":"Using one of the methods mentioned for retrieving data, your application can process the data resulting from the identification process on the test environment.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b2ba7a67-9a2b-4e2d-9d24-9a4e4281895d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"e6252c49-5616-4fba-90a8-2cddd103ebc1"}}],"_postman_id":"70e0aff6-82d9-4e4b-9d71-dbbbbc889d00"}],"id":"5e5e2d05-a773-4a6f-bf6d-29a01953dfe6","description":"To test whether your application is correctly communicating with the IDnow application, IDnow supports 2 different methods of processing an identification. Depending on the type of test, the agent part of the procedure will be automated.
\nIDnow Test Robot is a service running on the test environment and simulates a call center agent when a review is required by simply clicking through the procedure. The term Company Test Implementation refers to a custom implementation of the company to automate the testing on their side. For details continue reading.
\nThe IDnow Test Robot supports Autoident.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"bd66b513-36d7-4d19-ae7b-c258baf3309f"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"32679344-8ec9-4cec-bce4-dc2cf4334e95"}}],"_postman_id":"5e5e2d05-a773-4a6f-bf6d-29a01953dfe6"},{"name":"Retries for changed Ident","item":[],"id":"aaf25c2f-4414-4b47-a373-000d215c1c55","description":"If a webhook fails and an Ident was changed in the meantime, the webhook will not be sent again.
\nExample:
\nA REALTIME webhook is sent but your system returns an error. In the meantime, the identification is reviewed and set to SUCCESS. Now the REALTIME webhook is outdated and will therefore be deleted. Otherwise, you might receive a REALTIME webhook after the FINAL webhook.
If this happens, we will send you a warning e-mail with the following subject:
IDnow Webhook Error: Not sending for <transactionnumber> since identification was changed\n\nIf this option is used, the company needs to choose a password and communicate it to IDnow. Then for every Ident verification, the results will be encrypted using the given password in a ZIP-file and sent via mail to the company. The encryption used is AES 256. To open the file on Windows use a dedicated tool, e.g. 7-Zip.
\n","_postman_id":"5629044c-fb3c-4355-acc5-d8bffadd43c6"},{"name":"Encrypted Mail with ZIP (S/MIME)","item":[],"id":"e3f31f8a-f05c-4739-83ad-d9911d2e3c11","description":"If this option is used, the company needs to generate a private/public key pair and communicate the public key to IDnow. The following certificate formats (and respective file extensions) are supported:
\n.der).cer, .pem).p7b)Then for every Ident, the results will be sent as ZIP-file via a secure mail. The mail as well as its attachment get encrypted.
\n","_postman_id":"e3f31f8a-f05c-4739-83ad-d9911d2e3c11"},{"name":"E-Mail with Download Link","item":[],"id":"a2ce4668-01f0-4a75-8417-bbebb732677f","description":"With this option, you will receive an e-mail per Ident, which contains a link to the secure download webform, where the data can be downloaded using the respective credentials.
\n","_postman_id":"a2ce4668-01f0-4a75-8417-bbebb732677f"}],"id":"fe6a61fc-f215-423d-8915-47a8f8b88675","description":"To set up one of the following methods, contact us via support@idnow.io. For details on the format of the retrievable data, see chapter Result Data.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"953e3506-a36e-4eb3-9dc3-11535a99acdc"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a77bd601-ec33-4668-b4e3-cbc709bc47a8"}}],"_postman_id":"fe6a61fc-f215-423d-8915-47a8f8b88675"},{"name":"HTTP Responses","item":[{"name":"Success","item":[],"id":"136b4177-b532-4cb5-8f57-c91503c0bfc0","description":"The following tables lists the successful API responses:
\n","_postman_id":"136b4177-b532-4cb5-8f57-c91503c0bfc0"},{"name":"Errors","item":[],"id":"bf75e492-a481-41a3-bc9f-bb7f0d302b3c","description":"The following errors might occur when using the API:
\nThe following table contains details of the possible causes of errors:
\nIf you get one of these errors, the server will send additional information in the response body. Those error responses all have the same structure.
\nExample for a missing or wrong API key:
\n HTTP status code: 401\n {\n \"errors\": [{\n \"cause\": \"INVALID_LOGIN_TOKEN\",\n \"id\": \"487800773\",\n \"key\": null,\n \"message\": null\n }]\n }\n\nExample for a badly formatted date field:
\n HTTP status code: 400\n {\n \"errors\": [{\n \"cause\": \"BAD_REQUEST\",\n \"id\": \"73464627\",\n \"key\": \"birthday\",\n \"message\": \"Please provide a correct value for ‘birthday’\" \n }]\n }\n\nExample when trying to update a finished Ident:
\n HTTP status code: 409\n {\n \"errors\": [{\n \"cause\": \"EXISTING_IDENTIFICATION\",\n \"id\": \"34253467\",\n \"key\": null,\n \"message\": null \n }]\n }\n\nExplanation of the attributes:
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"1fdf89b1-a6a7-4c20-b66b-692f2d2d3211"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"0431d4ec-fdaf-4d97-8070-a01fdaa66b5d"}}],"_postman_id":"bf75e492-a481-41a3-bc9f-bb7f0d302b3c"},{"name":"API Responses","item":[],"id":"15d2e922-58f0-4f87-be3e-4dc81a8c81aa","description":"","_postman_id":"15d2e922-58f0-4f87-be3e-4dc81a8c81aa"}],"id":"8ea788dd-d529-4d6b-a17a-73fb85bce30a","description":"This section lists API responses that you can encounter when accessing the IDnow API.
\n","_postman_id":"8ea788dd-d529-4d6b-a17a-73fb85bce30a"}],"id":"8d2415ea-0672-49a9-8da4-4716cfac7e2e","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"bbf134d5-cbc9-4e78-9ed0-9d318f27dd16"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"e5ab7080-5fc3-40ee-915c-1682e6d5d870"}}],"_postman_id":"8d2415ea-0672-49a9-8da4-4716cfac7e2e","description":""}],"event":[{"listen":"prerequest","script":{"id":"dd2eefe6-e741-402c-bb81-26243a5447c2","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"356f21a8-f6ee-4e2c-8bb1-b932e9b53640","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"IDENTID","value":""},{"key":"TRANSACTION-NUMBER","value":""},{"key":"GATEWAYHOST","value":""},{"key":"CUSTOMER","value":""},{"key":"APIKEY","value":""}]}