The API allows the user to get definitions of a specific document based on the identifier of the document definition passed in the request.
\n","urlObject":{"path":["api","v1","{{CUSTOMER}}","documentdefinitions","(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":"file","file":{"src":""}},"url":"https://gateway.test.idnow.de/api/v1/{{CUSTOMER}}/documentdefinitions/The API allows the user to upload the document that defines document definition or configuration which will be used as the basis when a new signature process is created. The user can use this for documents which are the same for all users (e.g. Terms and Conditions which are not customized per user).
\n","urlObject":{"path":["api","v1","{{CUSTOMER}}","documentdefinitions","Bad Request
\n\n For request 'POST /api/v1/ihrebank/documentdefinitions/agb/data' [Error decoding json body: com.fasterxml.jackson.databind.JsonMappingException: No content to map due to end-of-input\n at [Source: (akka.util.ByteIterator$ByteArrayIterator$$anon$1); line: 1, column: 0]]\n
\n \n"}],"_postman_id":"58bf99d2-d9b2-437a-a430-cb0dff764d9c"},{"name":"Download default document","id":"ab2f4bde-5dce-4f28-9c10-3894216bb457","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"(REQUIRED) The media type
\n","type":"text"},{"key":"X-API-LOGIN-TOKEN","value":"{{LOGIN-TOKEN}}","description":"(REQUIRED) Your private Auth Token
\n","type":"text"}],"url":"https://gateway.test.idnow.de/api/v1/{{CUSTOMER}}/documentdefinitions/Starts the download of a default document.
\nIf called with valid credentials, the server response will be similar to the following example:
\n % Total % Received % Xferd Average Speed Time Time Time Current\n Dload Upload Total Spent Left Speed\n100 11 0 11 0 0 390 0 --:--:-- --:--:-- --:--:-- 407\n### Upload Document to be Signed Through File Upload Page
\nIf you want the user to upload the document to be signed by himself, you can use our file upload page. For this, the user has to download the contract on your side, and upload the document on our side.
\nNOTE: You can only do this for one document (the first document definition as determined by the order field). If you create several document definitions and do not provide default document or upload using the REST API, the user will not be able to start the signature/identification process.
\n","event":[{"listen":"prerequest","script":{"id":"9a62cc6e-be2e-4af5-bc13-bf97d1dc9c3c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b664172b-68ee-43ff-90c3-29074f8e5028","type":"text/javascript","exec":[""]}}],"_postman_id":"d3b824ec-9e2b-417d-9394-83f33c39b2a6"},{"name":"Download Signed Document Using SFTP/Encrypted E-Mail/Encrypted ZIP","item":[],"id":"f75fa304-f4e0-4056-99fa-6ccef724bbdf","description":"### Download Signed Document Using SFTP/Encrypted E-Mail/Encrypted ZIP
\nThe signed documents will be included in the result ZIP files as well using the name _signed.pdf (e.g. doc1_signed.pdf).
(REQUIRED) Your private Auth Token
\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"(REQUIRED) The media type
\n","type":"text"}],"url":"https://gateway.test.idnow.de/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/documents","description":"The IDnow system generates an instance of the document definition for each identification which will then be used to perform the identification. The API allows the user get list of the documents which are going to be signed in this process.
\n","urlObject":{"path":["api","v1","{{CUSTOMER}}","identifications","{{TRANSACTION-NUMBER}}","documents"],"host":["https://gateway.test.idnow.de"],"query":[],"variable":[]}},"response":[{"id":"130aa0ce-6432-4d0e-81a7-3e4626b7e0f9","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":"https://gateway.test.idnow.de/api/v1/{{CUSTOMER}}/identifications/(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":"https://gateway.test.idnow.de/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/documents/The API allows the user to get a single document which is going to be signed in the process.
\n","urlObject":{"path":["api","v1","{{CUSTOMER}}","identifications","{{TRANSACTION-NUMBER}}","documents","(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":"{\n \"version\": \"3\",\n \"name\": \"DOC\",\n \"signatures\": {\n \"mysignature1\": {\n \"position\": {\n \"page\": \"1\",\n \"left\": 800,\n \"width\": 200,\n \"bottom\": 100,\n \"height\": 35\n },\n \"type\": \"ELECTRONIC\",\n \"optional\": \"false\",\n \"signatureImage\": \"hsqes_stamp\"\n }\n }\n}\n"},"url":"https://gateway.test.idnow.de/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/documents/The IDnow system uses each document definitions set up to create instances when an identification is created. It is possible to modify these instances in certain limits before the identification is started. The elements name, version and signatures can be updated. The parameters name and version will overwrite the one given from the document definition. The last parameter signatures takes a special place:
- \n
A signature of the document definition can be overwritten if the respective identifier is used
\n \nA signature with a new identifier can extend the scope of the signatures
\n \n
You can overwrite the document definition by posting a JSON with the respective elements (name, version and signatures). For details on their format and allowed values, refer to the previous sections.
The fields mentioned in the body section below are applicable for Namirial TSP.
\n","urlObject":{"path":["api","v1","{{CUSTOMER}}","identifications","{{TRANSACTION-NUMBER}}","documents","(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":"https://gateway.test.idnow.de/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/documents/Thr API allows the user to upload a document for esigning. Since there are different types or class of documents for different users, it is therefore necessary to provide unique document definition identifier which identifies the class of document for a specific user that is to be uploaded.
\nThe defined documents (without default file) need to be uploaded in order to perform the eSigning identification. These are the documents which differ for each user, e.g. the contract likely has the user's name on it and therefore needs to be uploaded for every user. Note that identifier of a document definition therefore refers to a class of documents rather than to a specific document (because each user has a different name and therefore a different document of the same class, though).
\nNote
\n- \n
By 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. In case your setup uses DocuSign as a TSP then the limit is 10MB.
\n \nThe maximum number of documents that can be uploaded in a single ident is 25(please reach out to your account manager or customer success representative in case you are not aware which TSP you have been setup for)
\n \n
(REQUIRED) Your private Auth Token
\n","type":"text"}],"url":"https://gateway.test.idnow.de/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/sign","description":"If you are enabled for \"InstantSign Advanced Electronic Signature(AES) API only\" flow, you can use this endpoint to trigger signing via an AES signature type. Please note - the preconditions of creating an InstantSign ident with first name, last name only and uploading of PDF to be signed still apply.
\nNo request body params applicable for this endpoint.
\n","urlObject":{"path":["api","v1","{{CUSTOMER}}","identifications","{{TRANSACTION-NUMBER}}","sign"],"host":["https://gateway.test.idnow.de"],"query":[],"variable":[]}},"response":[{"id":"58bac122-5351-40b8-b89e-621584f5f55b","name":"200","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/pdf","description":"**(REQUIRED)** The media type","type":"text","disabled":true}],"url":"https://gateway.test.idnow.de/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/sign"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"5516883b-db0b-4b60-8b29-afef9c6b45e9","name":"400","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/pdf","description":"**(REQUIRED)** The media type","type":"text","disabled":true}],"url":"https://gateway.test.idnow.de/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/sign"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"ea6d7989-d6d4-4a00-be79-ef8ce66ed01b","name":"412","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/pdf","description":"**(REQUIRED)** The media type","type":"text","disabled":true}],"url":"https://gateway.test.idnow.de/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/sign"},"status":"Precondition Failed","code":412,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"ae0395d8-372b-4cc2-9e45-702813959fef","name":"500","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/pdf","description":"**(REQUIRED)** The media type","type":"text","disabled":true}],"url":"https://gateway.test.idnow.de/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/sign"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b409375a-ceb1-4bf9-ac49-e32a264e5e2f"},{"name":"Download Signed Document ","id":"f3117976-bebe-4b4c-b1d3-f0ef00466776","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":"https://gateway.test.idnow.de/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/documents/{{DOCUMENT-DEFINITION-IDENTIFIER}}/signed","description":"### Download Signed Document Using REST
\nThe API alllows the user to download a specified signed document.
\nIf called with valid credentials, the server response will be similar to the following example:
\n % Total % Received % Xferd Average Speed Time Time Time Current\n Dload Upload Total Spent Left Speed\n100 11 0 11 0 0 390 0 --:--:-- --:--:-- --:--:-- 407\n\nNot Found
\n\n For request 'POST /api/v1/ibankesigning/jun211617/documents/doc/signed'\n
\n \n"}],"_postman_id":"f3117976-bebe-4b4c-b1d3-f0ef00466776"}],"id":"63f262aa-479e-4739-8c1b-9163eb544ec4","description":"\n\nFor each identification/signing process, you can list the documents to be signed as well as upload documents to be signed and finally get the signed result of the identification.
\n","_postman_id":"63f262aa-479e-4739-8c1b-9163eb544ec4"}],"id":"fed98f4e-0d72-43b3-8d1a-1cd5d51c4686","description":"# Identifications with eSign
\nUsing the eSign API, you can upload documents to be signed by the user during the identification. Note: eSigning cannot be done without an identification except in the case of InstantSign where IDnow can issue an electronic signature based on identity data provided by the customer(only applicable to AML compliant customers like banks, financial services etc.).
\nDocuments can be provided by:
\n- \n
Uploading them using the REST API for each user (e.g. the contract of the user)
\n \nLetting the users upload themselves using a file upload on the website of IDnow
\n \nProviding a default document (e.g. Terms & Conditions which do not change for each user)
\n \n
The high-level flow of an eSigning using the REST API is as follows:
\nIf you do not have the possibility to pass data to IDnow, then you can use a static link to a webform that is hosted by IDnow. In this webform, the user will be prompted to enter his personal data that is used during the identification.
\nTo create an identification with eSigning, the respective documents need to be uploaded. This can also be done by the user in the webform. For details on eSigning look up chapter Identifications with eSigning.
\nExample of the Webform Userdata
\nAn example of the landing page can be found at\nhttps://go.idnow.de/video-demo/userdata
\nFeature activation
\nTo activate this feature of the API, please inform your technical account manager at IDnow.
\nURL to the Form
\nYou can either call the webform with a static link (no parameters) or by passing a transaction number as a parameter. You can use the transaction number after the identification to easily match the identification result with your internal processes.
\nOption 1: Static Link
\nUse this link if you cannot attach parameters to links or if you do not have a transaction number of the user available:
\nhttps://go.idnow.de/video-demo/userdata
\nOption 2: Link with Transaction Number Parameter
\nUse this link if you can attach parameters and have a transaction number:
\nhttps://go.idnow.de/video-demo/userdata/123456
\n","event":[{"listen":"prerequest","script":{"id":"d9e7f5d2-d94d-4bfa-97aa-f8ad95d92811","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6fb654d8-cd6e-4705-a0d0-c73e161f0577","type":"text/javascript","exec":[""]}}],"_postman_id":"a54b0b8b-3cf7-43f4-bf37-5fc6eb173e17"},{"name":"Campaign Tracking","item":[],"id":"f95a4cc6-db93-4534-98d8-c050f7a7a70c","description":"\nYou can pass a tracking ID e.g. to track marketing campaigns in the browser. To use this feature, append the tid parameter to the created link:
Note: Only use the CH-servers if you are in Switzerland. For all other countries, use the DE-servers.
\nThe content of the tracking ID will be returned in the trackingid field in the results. If you also need the trackingid in the result PDF, please contact IDnow support.
This endpoint may be called every 5 minutes.
\n","_postman_id":"7ac60dec-66d4-47a2-942e-5a7475d30e04"}],"id":"047c915d-5ad5-4bd8-bc60-8f1f9c3d1c3e","description":"\nThe 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 for the server located in Germany:
\n curl -i https://gateway.test.idnow.de/system_check\nAn HTTP GET request to the following URL will execute the system check for the server located in Switzerland:
\n curl -i https://go.test.online-ident.ch/system_check\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.
### Timing
\nIDnow can execute different webhooks depending on your needs:
\nAn example:
\n- \n
Your account has
\nREALTIMEresults active. \nUser tries to verify but fails since the internet connection is not good enough. You will receive a webhook for this aborted Ident.
\n \nUser tries again and successfully finishes the verification. You receive a real-time webhook right after the identification with status
\nREVIEW_PENDING. \nIDnow finishes the review. You receive another webhook with the final results.
\n \n
The following diagram shows the state transitions of an ident along with triggered webhooks and how unsent webhooks are treated:
\n### IPs
\nWebhooks will be sent from the following source IPs:
\n","_postman_id":"94b4f5b7-f939-4c41-b1c9-8818e612c3a0"},{"name":"Real-time/Final Webhooks","item":[],"id":"1d96d7a4-73f1-415b-be6d-a3523279f534","description":"\nThe JSON of one 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 }\nThe JSON structure is similar to the JSON from successful webhooks.
\nThe differences are as follows:
\n","event":[{"listen":"prerequest","script":{"id":"3b6fb1b9-7541-481c-b59c-6c43a07afc27","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d14b9c78-07bf-4d17-ad1a-9f7d01e659a2","type":"text/javascript","exec":[""]}}],"_postman_id":"1fb97ddb-24c3-43b9-8d6f-71f3c6fd6b0a"},{"name":"JSON Content","item":[],"id":"c63ec69e-0eb6-423a-97b1-e6a1aa236cce","description":"\nThe JSON of one identification is passed in the body of the call to the webhook.
\n {\n \"identificationprocess\": {\n \"result\": \"CANCELED\",\n \"reason\": \"DATA_APPLICATION_DATA\",\n \"companyid\": \"democompany\",\n \"agentname\": \"HMUELLER\",\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 }\nIDnow informs you about failed 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":{"id":"462f76bf-d73f-4e18-8181-79f4e9a9416a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"59403e2a-d5b1-4da6-a7d0-7b704af13e6c","type":"text/javascript","exec":[""]}}],"_postman_id":"c63ec69e-0eb6-423a-97b1-e6a1aa236cce"},{"name":"Reasons for Failure / Cancellation","item":[],"id":"0e147883-79b5-47e5-b5c0-65cfcb959bee","description":"","event":[{"listen":"prerequest","script":{"id":"7aa980df-19ee-47ae-867c-c1cf9d0401e3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"902878c7-30eb-4154-bbbf-3c77598c53df","type":"text/javascript","exec":[""]}}],"_postman_id":"0e147883-79b5-47e5-b5c0-65cfcb959bee"}],"id":"c09d5dd3-96af-4f17-985d-a58d84967542","description":"## Webhooks
When this feature is activated for your account, after each identification a backend call (JSON POST) to a URL on your servers will be executed by the IDnow system.
To activate the feature please contact your technical account manager at IDnow.
\n","_postman_id":"c09d5dd3-96af-4f17-985d-a58d84967542"},{"name":"Webhook Retry Support","item":[{"name":"Warn/Error E-Mails","item":[],"id":"9eea5467-a46f-465e-884e-386375b2414d","description":"\nIf a webhook fails, you will first receive an e-mail with the following subject:
\n IDnow Webhook Warning: Unable to send for <transactionnumber>. Retrying.\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.\nThe recipient of the e-mail is the technical contact as defined during account setup.
\n","_postman_id":"9eea5467-a46f-465e-884e-386375b2414d"},{"name":"Retries for changed Ident","item":[],"id":"af1d648f-e20d-4a06-b8e9-3f3e8b902b09","description":"\n\nIf 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.\nIf 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## Webhook Retry Support
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.
You can request a test with an IDnow agent on the test environment. Please contact acm@idnow.de for 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 this sort of testing.
\n","_postman_id":"9da63321-efab-4fba-82b9-32815789e40a"},{"name":"Checking the Results","item":[],"id":"b1aa55d5-7715-492b-8eaf-c978121e1b9c","description":"\n\nUsing one of the methods mentioned for retrieving data, your application can process the data resulting from the identification process on the test environment.
\n","_postman_id":"b1aa55d5-7715-492b-8eaf-c978121e1b9c"}],"id":"e3eaacd4-75ca-49b3-ae2e-c4bfb80826c0","description":"## Testing
\nIDnow offers automated test support tools for your integration and Quality Assurance efforts.
The full description of the Test-Robot, what it is, how to use it and trigger it is described in section IDnow Onboarding - Test-Robot. Please refer to this link
If 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":"45123770-07cd-4f4b-bec9-873976fc8131"},{"name":"Encrypted Mail with ZIP (S/MIME)","item":[],"id":"5577cc5a-dfe1-4991-b619-cab0d32ea566","description":"\nIf 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- \n
- DER binary encoded X.509 (
.der) \n - Base64 encoded X.509 (
.cer,.pem) \n - PKCS#7 (
.p7b) \n
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":"5577cc5a-dfe1-4991-b619-cab0d32ea566"},{"name":"E-Mail with Download Link","item":[],"id":"b694f6f1-e7af-49ad-9bee-580aa6cdf7b9","description":"\nWith 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":"b694f6f1-e7af-49ad-9bee-580aa6cdf7b9"}],"id":"004c8e1b-6a4c-43fb-bcfe-c57fd7643749","description":"\nTo set up one of the following methods, contact us via acm@idnow.de. For details on the format of the retrievable data, see chapter Result Data.
\n","_postman_id":"004c8e1b-6a4c-43fb-bcfe-c57fd7643749"},{"name":"HTTP Responses","item":[{"name":"Success","item":[],"id":"6bb6e0d1-1303-463f-93e2-d7100565da98","description":"\n\nThe following tables lists the successful API responses:
\n","_postman_id":"6bb6e0d1-1303-463f-93e2-d7100565da98"},{"name":"Errors","item":[],"id":"45a4e8d6-6db4-484e-ad7e-8cd6e47a3bbb","description":"\nThe following errors might occur when using the API:
\nThe following table contains details on the causes:
\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 }\nExample for a badly formatted date field:
\n HTTP status code: 400\n \n {\n \"errors\": [{\n \"cause\": \"BAD_REQUEST\",\n \"id\": \"73464627\",\n \"key\": \"birthday\",\n \"message\": \"Please provide a correct value for ‘birthday’\" \n }]\n }\nExample when trying to update a finished Ident:
\n HTTP status code: 409\n \n {\n \"errors\": [{\n \"cause\": \"EXISTING_IDENTIFICATION\",\n \"id\": \"34253467\",\n \"key\": null,\n \"message\": null \n }]\n }\nExplanation of the attributes:
\n","event":[{"listen":"prerequest","script":{"id":"ae48289c-9ae5-4ac7-af5a-8623cd35e2a4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"068a2356-878e-4060-8e97-cc83e11ec5a6","type":"text/javascript","exec":[""]}}],"_postman_id":"45a4e8d6-6db4-484e-ad7e-8cd6e47a3bbb"},{"name":"API Responses","item":[],"id":"3be11213-c463-42b0-a489-a726fd196dec","description":"\n","_postman_id":"3be11213-c463-42b0-a489-a726fd196dec"}],"id":"756c8a6c-d2d7-4bca-aea5-0cd1facf65d9","description":"\nThis section lists API responses that you can encounter when accessing the IDnow API.
\n","_postman_id":"756c8a6c-d2d7-4bca-aea5-0cd1facf65d9"}],"id":"25c80554-f1dc-4318-9fd7-529b07ea52bd","event":[{"listen":"prerequest","script":{"id":"65054157-860b-4040-8440-8f32830a786d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d70c8f13-c18f-45fc-a03d-ba10a5e0e69e","type":"text/javascript","exec":[""]}}],"_postman_id":"25c80554-f1dc-4318-9fd7-529b07ea52bd","description":""},{"name":"Flow Diagrams","item":[],"id":"603d9bec-e2b8-410d-aa42-de3f6ce907fe","description":"## eID Process Flow
\nIn order to use eID verification process, the users need to possess
\n- \n
Ident Token from the service provider
\n \nA Mobile device that supports NFC capability
\n \nGerman Electronic ID card with 6 digit PIN
\n \n
Once these requirements are fulfilled, users can use IDnow Online Ident Android or iOS app to perform identification. Once the process is successfully finished, the results are delivered to the customer using Webhooks and result Zip including PDF and XML.
\n