![](\"https://docs.images.idnow.io/images/New-Flow-Auto-Review-disabled.png\")
\n\n![](\"https://docs.images.idnow.io/images/New-Flow-Auto-Review-enabled.png\")
\n\n![](\"https://docs.images.idnow.io/images/drivers-license-backside.png\")
\n\nRetrieves a single document definition.
\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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/documentdefinitions/You can upload the document for a document definition which will be used as the basis when a new signature process is created. You 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":"2fcd787e-df1a-425c-8a27-afaaf67279b9"},{"name":"Download default document","id":"73ae5a50-2e16-4e87-a0eb-d666c43398a4","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":"{{GATEWAYHOST}}/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\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.
\n![\"Upload](\"https://docs.images.idnow.io/images/fileUploadPage.png\")
NOTE: 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":"d6fc4ce2-3fb1-44e4-9cd4-83b3c04229b4"},{"name":"Download Signed Document Using SFTP/Encrypted E-Mail/Encrypted ZIP","item":[],"id":"4db2ada9-c841-484c-90ff-8308c68f55e1","description":"\n\nThe signed documents will be included in the result ZIP files as well using the name <documentDefinitionIdentifier\\>_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":"{{GATEWAYHOST}}/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.
\nYou can list the documents which are going to be signed in this process.
\n","urlObject":{"path":["api","v1","{{CUSTOMER}}","identifications","{{TRANSACTION-NUMBER}}","documents"],"host":["{{GATEWAYHOST}}"],"query":[],"variable":[]}},"response":[{"id":"f3ae13af-c4d7-45f0-8cb8-dfd58f4c04a2","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":"{{GATEWAYHOST}}/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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/documents/With this request you can list a single document which is going to be signed in this 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\": \"doc3\"\n}"},"url":"{{GATEWAYHOST}}/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
- A signature with a new identifier can extend the scope of the signatures \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.
(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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/documents/The 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).
\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"}],"url":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/documents/{{DOCUMENT-DEFINITION-IDENTIFIER}}/signed","description":"\n\nStarts the download of a 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\nNot Found
\n\n For request 'POST /api/v1/ibankesigning/jun211617/documents/doc/signed'\n
\n \n"}],"_postman_id":"36c98606-1088-464a-bbc5-abbf381b96fa"}],"id":"b6ef5eb9-0bd3-49f3-ac53-f6c10e5c046f","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":"b6ef5eb9-0bd3-49f3-ac53-f6c10e5c046f"}],"id":"3a5f4324-5fb8-41b4-8d1f-b9b02b7596aa","description":"\n\nUsing the eSign API, you can upload documents to be signed by the user during the identification. eSigning cannot be done without an identification.
\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
Creates new document definitions. Fields name, identifier, optional and mimeType are mandatory. For more details, refer to section Document Definition.
(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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/documentdefinitions/{{DOCUMENT-DEFINITION-IDENTIFIER}}","description":"Updates a single document definition. The value of the identifier field cannot be updated. Values of other fields such as name, mimeType, optional can be updated.
(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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/documentdefinitions/{{DOCUMENT-DEFINITION-IDENTIFIER}}","description":"Deletes an existing document definition.
\n","urlObject":{"path":["api","v1","{{CUSTOMER}}","documentdefinitions","{{DOCUMENT-DEFINITION-IDENTIFIER}}"],"host":["{{GATEWAYHOST}}"],"query":[],"variable":[]}},"response":[{"id":"4ba0f695-5af3-4653-bdc7-8b0e11f35e36","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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/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":"bc5fa559-83c9-4bc0-a5f2-56a29e00b114"},{"name":"List document definitions","id":"aa3ae8f3-80bf-4915-b318-29ec4807b0d1","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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/documentdefinitions","description":"Lists all existing document definitions.
\n","urlObject":{"path":["api","v1","{{CUSTOMER}}","documentdefinitions"],"host":["{{GATEWAYHOST}}"],"query":[],"variable":[]}},"response":[{"id":"29d68870-163a-42a8-beb1-de5face57ddb","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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/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":"aa3ae8f3-80bf-4915-b318-29ec4807b0d1"},{"name":"Single document definition","id":"6ca05c6c-abbe-46de-9c7b-b343f567b359","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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/documentdefinitions/{{DOCUMENT-DEFINITION-IDENTIFIER}}","description":"Retrieves a single document definition.
\n","urlObject":{"path":["api","v1","{{CUSTOMER}}","documentdefinitions","{{DOCUMENT-DEFINITION-IDENTIFIER}}"],"host":["{{GATEWAYHOST}}"],"query":[],"variable":[]}},"response":[{"id":"ec9ba7b6-2938-41ee-81cd-8522623bdfb8","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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/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":"f8477fd5-209f-40ac-8a9e-8e4d800bb655","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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/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":"6ca05c6c-abbe-46de-9c7b-b343f567b359"}],"id":"4c80a485-7cc2-4c42-ac91-7caba701adec","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 process.
\nKey points to note:
\n- \n
- A document definition only needs to be created once for each customer account. The definition does not need to be created for each Ident. \n
- A document definition only needs to be created for the ID Verification with Contract Signing use case. \n
- For the Contract Signing use case, AutoIdent only supports signing one contract document during an Ident. Hence, only one document definition should be created. Creating more than one will cause exceptions when initiating the Ident. \n
- The value of the
identifierfield specified while creating the Document Definition must match the IDnow backend account configuration. Please contact your IDnow account representative to ensure this configuration and setup is done correctly. \n - For ID Verification without Contract Signing, it is not required to manually create a document definition. These will be created automatically by the system. \n
The ident creation process is similar to creating a regular ident request. However, when creating an ident request for AutoIdent QES / eSign, the following required fields need to be additionally specified in the CREATE IDENT request:
\nfirstname, lastname, email, country, mobilephone and preferredLang
The below example shows the preferredLang parameter in the body of the CREATE IDENT call:
\n{ \n \"firstname\":\"John\", \n \"lastname\":\"Smith\",\n \"email\":\"john@email.com\",\n \"country\":\"DE\",\n \"mobilephone\":\"+490778899000\",\n \"preferredLang\":\"en\"\n}\n\n(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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/documents/{{DOCUMENT-DEFINITION-IDENTIFIER}}/data","description":"\n\nAllows 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.
\n","urlObject":{"path":["api","v1","{{CUSTOMER}}","identifications","{{TRANSACTION-NUMBER}}","documents","{{DOCUMENT-DEFINITION-IDENTIFIER}}","data"],"host":["{{GATEWAYHOST}}"],"query":[],"variable":[]}},"response":[{"id":"5642c858-3721-4fd7-8f55-0fb05204541f","name":"Upload document 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"}],"body":{"mode":"file","file":{}},"url":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/documents/{{DOCUMENT-DEFINITION-IDENTIFIER}}/data"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"vary","value":"Origin"},{"key":"date","value":"Fri, 28 Jan 2022 12:45:40 GMT"},{"key":"content-length","value":"0"},{"key":"strict-transport-security","value":"max-age=16000000;"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"be0f6f2a-3cb6-4975-b444-dede015ffdb8"}],"id":"3da619ba-d817-4194-8da5-738ef0accf50","description":"\n\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":"3da619ba-d817-4194-8da5-738ef0accf50"},{"name":"View document to be signed","item":[{"name":"Single document","id":"2fbae76a-14e1-48fb-9185-8e1e601b94ae","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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/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","{{CUSTOMER}}","identifications","{{TRANSACTION-NUMBER}}","documents","{{DOCUMENT-DEFINITION-IDENTIFIER}}"],"host":["{{GATEWAYHOST}}"],"query":[],"variable":[]}},"response":[{"id":"e09cbf94-13e7-4e0d-8d6c-92f42251f36b","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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/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":"05234994-1f2b-4a7e-af9a-0c16a2d51846","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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/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":"2fbae76a-14e1-48fb-9185-8e1e601b94ae"},{"name":"List documents","id":"4017bdab-7925-40d9-8983-9aef26d7c635","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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/documents","description":"This request lists the details and statuses of documents that will be signed in a particular identification/signing process.
\n","urlObject":{"path":["api","v1","{{CUSTOMER}}","identifications","{{TRANSACTION-NUMBER}}","documents"],"host":["{{GATEWAYHOST}}"],"query":[],"variable":[]}},"response":[{"id":"dca9c760-2242-41af-b682-38a3be7ccce9","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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/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":"4017bdab-7925-40d9-8983-9aef26d7c635"}],"id":"562defc0-5d24-42a6-9145-217b45bbc42f","description":"\n\nThis 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":"562defc0-5d24-42a6-9145-217b45bbc42f"},{"name":"Download Signed Document","item":[{"name":"Download Signed Document ","id":"e277ed6b-9033-48fd-98b4-c7aed2016c99","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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/documents/{{DOCUMENT-DEFINITION-IDENTIFIER}}/signed","description":"\n\nThis request downloads the signed document.
\n","urlObject":{"path":["api","v1","{{CUSTOMER}}","identifications","{{TRANSACTION-NUMBER}}","documents","{{DOCUMENT-DEFINITION-IDENTIFIER}}","signed"],"host":["{{GATEWAYHOST}}"],"query":[],"variable":[]}},"response":[{"id":"869d732d-6d69-4ae2-a96b-0b255d04cdbe","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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/documents/{{DOCUMENT-DEFINITION-IDENTIFIER}}/signed"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a9667c42-7606-4ec8-9d10-2dcf19bf667f","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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/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":"d347bc74-9c0e-4515-a159-2ba99b3226bd","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":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/identifications/{{TRANSACTION-NUMBER}}/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":"e277ed6b-9033-48fd-98b4-c7aed2016c99"}],"id":"e38d9b48-b1fa-42ec-8a63-c501007aaaa1","description":"\n\nThe 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":"e38d9b48-b1fa-42ec-8a63-c501007aaaa1"}],"id":"1e7c55d1-77de-4fdd-9e71-0f48d0b58dcd","description":"\n\nFor each identification with document signing process, 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":"1e7c55d1-77de-4fdd-9e71-0f48d0b58dcd"}],"id":"ff6ba6d6-3a22-4f1c-b3fd-51ee0b71637f","description":"\n\nAutoIdent supports performing ID Verification using qualified electronic signatures in compliance with AML regulations, using the QES/eSign module. The following use cases are supported:
\n- \n
- AML-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. \n
- AML-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. \n
- GwG-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. \n
A document (e.g. the Contract PDF document which is to be signed by the user) can be provided by:
\n- \n
- Uploading it using the Upload Document API for the specific {{TRANSACTION-NUMBER}} which was used to create the identification request. \n
- Currently AutoIdent supports signing only one document, provided by the customer, during an Ident. \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":"{\n \"firstname\": \"PETR\",\n \"lastname\": \"AVEN\",\n \"nationality\": \"RU\",\n \"dateOfBirth\": \"1981-10-17\",\n \"reference\": \"test_reference\"\n}"},"url":"{{GATEWAYHOST}}/api/v1/{{CUSTOMER}}/pepAndSanctions/verify","description":"Perform a one-time screening of users on PEPs, sanctions, watchlists and adverse media data.
\n- \n
- If no match is found for a user, the response will have:
\"matchStatus\": \"NO_MATCH\"\n - If one or more matches are found, then the response will contain
\"matchStatus\": \"POTENTIAL_MATCH\"\n
Required input data
\nThis endpoint accepts the following fields via the body of the request:
\n- \n
firstname- string - mandatory \nlastname- string - mandatory \nnationality- string - 2 letter country code - mandatory \ndateOfBirth- date as string, formatyyyy-MM-dd- mandatory \nreference- any string can be used as a reference for this transaction - (max 255 chars) - mandatory \n
IDnow's AML Screening module allows you to screen your users on PEPs, sanctions lists, watchlists and adverse media data.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"9e3545c1-a96b-4203-9e78-ca2a0cb241df"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"4ca3ef25-14a8-480d-a942-a4a7d9f0d065"}}],"_postman_id":"0246775a-1b41-4368-a40e-9e6c62c98079"}]}