Postman Collections
Developer tools
To test Fourthline's API using Postman, copy the relevant raw JSON collection below, and then import it into Postman.
Hover over the top-right corner of the code block and click the Copy button: 
Identity Verification
European, Italian, and Spanish solutions
{
"info":{
"_postman_id":"2ad8dac8-1a31-44a4-a880-c60a7b1cf301",
"name":"Identity Verification: App Drop-in",
"schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id":"27570928"
},
"item":[
{
"name":"Create access token",
"request":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
},
"description":"Use this endpoint to create an access token valid for **1 hour** to authenticate requests to our API. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Make sure you address the correct [environment](doc:introduction#environments)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"token_type\": \"<string>\",\n \"access_token\": \"<string>\",\n \"expires_in\": \"<integer>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error_description\": \"<string>\",\n \"error\": \"<string>\"\n}"
}
]
},
{
"name":"Create workflow",
"request":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
},
"description":"Use this endpoint to create a workflow."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"workflowId\": \"<string>\",\n \"clientId\": \"<string>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\",\n \"errors\": [\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n}"
},
{
"name":"401",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Unauthorized",
"code":401,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error\": \"<string>\",\n \"error_description\": \"<string>\"\n}"
},
{
"name":"403",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Forbidden",
"code":403,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
},
{
"name":"500",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Internal Server Error",
"code":500,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
}
]
},
{
"name":"Create SDK session",
"request":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId",
"value":"<string>",
"description":"(Required) Our unique identifier for the workflow, returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to create an App Drop-in or Web SDK session for a workflow."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"validationCode\": \"<string>\",\n \"expiryDateTime\": \"<string>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\",\n \"errors\": [\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n}"
},
{
"name":"401",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Unauthorized",
"code":401,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error\": \"<string>\",\n \"error_description\": \"<string>\"\n}"
},
{
"name":"404",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\"\n}"
},
{
"name":"500",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Internal Server Error",
"code":500,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
}
]
},
{
"name":"Get case status",
"request":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/verificationresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"verificationresult"
],
"variable":[
{
"key":"verificationId",
"value":"<string>",
"description":"(Required) The `workflowId` returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to get the [status](https://docs.fourthline.com/docs/idv-statuses) of an Identity Verification case. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: To receive status updates automatically, set up a [webhook](https://docs.fourthline.com/docs/webhooks)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/verificationresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"verificationresult"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"verificationId\": \"<string>\",\n \"verificationStatus\": \"<string>\",\n \"dataValidationError\": {}\n}"
}
]
},
{
"name":"Get CDD PDF",
"request":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"text/plain"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:workflowId/getpdfresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":workflowId",
"getpdfresult"
],
"variable":[
{
"key":"workflowId",
"value":"<string>",
"description":"(Required) Our unique identifier for the workflow, returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to download the [CDD Report](https://docs.fourthline.com/docs/reports) in PDF format."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:workflowId/getpdfresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":workflowId",
"getpdfresult"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
}
]
},
{
"name":"Get CDD zipfile",
"request":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"text/plain"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/reports",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"reports"
],
"variable":[
{
"key":"verificationId",
"value":"<string>",
"description":"(Required) The `workflowId` returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to download a [CDD zipfile](https://docs.fourthline.com/docs/reports#identity-verification) containing the PDF CDD Report, all IDENTITY DATA in an XML file including any Fourthline corrections, and all supporting identity files. <br /><br /><img src=\"https://files.readme.io/ad2486a-Inline_Note.svg\" align=\"left\"/> **Note**: We **do not** convert media files we receive, so they are returned in the original format."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/reports",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"reports"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
}
]
}
],
"auth":{
"type":"oauth2"
},
"variable":[
{
"key":"baseUrl",
"value":"https://api.ext-sandbox.fourthline.com"
}
]
}French solution
{
"info":{
"_postman_id":"0fe761b3-c319-4ce8-9a6b-20760be821ff",
"name":"French Solution: App Drop-in",
"schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id":"27570928"
},
"item":[
{
"name":"Create access token",
"request":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
},
"description":"Use this endpoint to create an access token valid for **1 hour** to authenticate requests to our API. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Make sure you address the correct [environment](doc:introduction#environments)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"token_type\": \"<string>\",\n \"access_token\": \"<string>\",\n \"expires_in\": \"<integer>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error_description\": \"<string>\",\n \"error\": \"<string>\"\n}"
}
]
},
{
"name":"Create workflow",
"request":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
},
"description":"Use this endpoint to create a workflow."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"workflowId\": \"<string>\",\n \"clientId\": \"<string>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\",\n \"errors\": [\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n}"
},
{
"name":"401",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Unauthorized",
"code":401,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error\": \"<string>\",\n \"error_description\": \"<string>\"\n}"
},
{
"name":"403",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Forbidden",
"code":403,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
},
{
"name":"500",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Internal Server Error",
"code":500,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
}
]
},
{
"name":"Upload documents to sign",
"request":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId",
"value":"<string>",
"description":"(Required) Our unique identifier for the workflow, returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint for Qualified Electronic Signature flows to upload the document(s) to sign."
},
"response":[
{
"name":"202",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Accepted",
"code":202,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"traceId\": \"<string>\",\n \"errors\": {\n \"documentsToSign\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n}"
},
{
"name":"404",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\"\n}"
},
{
"name":"409",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Conflict",
"code":409,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\"\n}"
},
{
"name":"422",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Unprocessable Entity (WebDAV) (RFC 4918)",
"code":422,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\"\n}"
}
]
},
{
"name":"Upload mobile phone number",
"request":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/data",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"data"
],
"variable":[
{
"key":"workflowId",
"value":"<string>",
"description":"(Required) Our unique identifier for the workflow, returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint for Qualified Electronic Signature flows to upload the client’s mobile phone number for the [signature confirmation step](https://docs.fourthline.com/docs/qes-overview#signature-confirmation)."
},
"response":[
{
"name":"202",
"originalRequest":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/data",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"data"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Accepted",
"code":202,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"400",
"originalRequest":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/data",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"data"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"traceId\": \"<string>\",\n \"errors\": {\n \"MobilePhoneNumber\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n}"
},
{
"name":"404",
"originalRequest":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/data",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"data"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
}
]
},
{
"name":"Create SDK session",
"request":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId",
"value":"<string>",
"description":"(Required) Our unique identifier for the workflow, returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to create an App Drop-in or Web SDK session for a workflow."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"validationCode\": \"<string>\",\n \"expiryDateTime\": \"<string>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\",\n \"errors\": [\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n}"
},
{
"name":"401",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Unauthorized",
"code":401,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error\": \"<string>\",\n \"error_description\": \"<string>\"\n}"
},
{
"name":"404",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\"\n}"
},
{
"name":"500",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Internal Server Error",
"code":500,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
}
]
},
{
"name":"Get case status",
"request":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/verificationresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"verificationresult"
],
"variable":[
{
"key":"verificationId",
"value":"<string>",
"description":"(Required) The `workflowId` returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to get the [status](https://docs.fourthline.com/docs/idv-statuses) of an Identity Verification case. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: To receive status updates automatically, set up a [webhook](https://docs.fourthline.com/docs/webhooks)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/verificationresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"verificationresult"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"verificationId\": \"<string>\",\n \"verificationStatus\": \"<string>\",\n \"dataValidationError\": {}\n}"
}
]
},
{
"name":"Get CDD PDF",
"request":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"text/plain"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:workflowId/getpdfresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":workflowId",
"getpdfresult"
],
"variable":[
{
"key":"workflowId",
"value":"<string>",
"description":"(Required) Our unique identifier for the workflow, returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to download the [CDD Report](https://docs.fourthline.com/docs/reports) in PDF format."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:workflowId/getpdfresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":workflowId",
"getpdfresult"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
}
]
},
{
"name":"Get CDD zipfile",
"request":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"text/plain"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/reports",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"reports"
],
"variable":[
{
"key":"verificationId",
"value":"<string>",
"description":"(Required) The `workflowId` returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to download a [CDD zipfile](https://docs.fourthline.com/docs/reports#identity-verification) containing the PDF CDD Report, all IDENTITY DATA in an XML file including any Fourthline corrections, and all supporting identity files. <br /><br /><img src=\"https://files.readme.io/ad2486a-Inline_Note.svg\" align=\"left\"/> **Note**: We **do not** convert media files we receive, so they are returned in the original format."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/reports",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"reports"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
}
]
},
{
"name":"Get signature status",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId",
"value":"<string>",
"description":"(Required) The `workflowId` returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to get the [status](https://docs.fourthline.com/docs/qes-statuses) of a signature flow. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: To receive status updates automatically, set up a [webhook](https://docs.fourthline.com/docs/webhooks)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<string>\",\n \"statusCode\": \"<integer>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"traceId\": \"<string>\",\n \"errors\": {\n \"signatureId\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n}"
},
{
"name":"404",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\",\n \"traceId\": \"<string>\"\n}"
}
]
},
{
"name":"Get signed documents",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"text/plain"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/signedDocuments/:documentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"signedDocuments",
":documentId"
],
"variable":[
{
"key":"signatureId",
"value":"<string>",
"description":"(Required) The `workflowId` returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
},
{
"key":"documentId",
"value":"<string>",
"description":"(Required) Your unique identifier for the signed document that you passed in the [Upload documents to sign](doc:upload-documents-to-sign) request (`documentId`)."
}
]
},
"description":"Use this endpoint to download the signed documents when the [signature status](https://docs.fourthline.com/docs/qes-statuses) changes to `signed`."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/signedDocuments/:documentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"signedDocuments",
":documentId"
],
"variable":[
{
"key":"signatureId"
},
{
"key":"documentId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{\n \"examples\": {\n \"OK\": {\n \"value\": \"HTTP/1.1 200 OK\\nDate: Thu, 09 Jun 2022 12:49:03 GMT\\nContent-Type: application/pdf\\nTransfer-Encoding: chunked\\nConnection: close\\nContent-Disposition: attachment; filename=agreement1.pdf; filename*=UTF-8''agreement1.pdf\\napi-supported-versions: 1.0\\n{{binary content of the signed document}}\"\n }\n }\n}"
},
{
"name":"400",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/signedDocuments/:documentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"signedDocuments",
":documentId"
],
"variable":[
{
"key":"signatureId"
},
{
"key":"documentId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<integer>\",\n \"detail\": \"<string>\",\n \"signatureStatus\": \"<string>\"\n}"
},
{
"name":"404",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/signedDocuments/:documentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"signedDocuments",
":documentId"
],
"variable":[
{
"key":"signatureId"
},
{
"key":"documentId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\",\n \"traceId\": \"<string>\"\n}"
}
]
},
{
"name":"Get InfoCert contract",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/qtspAgreement",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"qtspAgreement"
],
"variable":[
{
"key":"signatureId",
"value":"<string>",
"description":"(Required) Our unique identifier for the signature returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"If you have the [fallback QTSP](https://docs.fourthline.com/docs/qes-integration#qtsps) option configured, when the signature status changes to `signed`, use this endpoint to check if an InfoCert contract was generated to share with the client."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/qtspAgreement",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"qtspAgreement"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"204",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/qtspAgreement",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"qtspAgreement"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"No Content",
"code":204,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"400",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/qtspAgreement",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"qtspAgreement"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"404",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/qtspAgreement",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"qtspAgreement"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
}
]
},
{
"name":"Test signature flow",
"request":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"text/plain"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"deviceMetaData\": {\n \"language\": \"<string>\",\n \"model\": \"<string>\",\n \"region\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\"\n },\n \"expectation\": {\n \"status\": \"user_consent_required\",\n \"statusCode\": \"<integer>\",\n \"verificationId\": \"<string>\"\n },\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/testendpoint/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"testendpoint",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId",
"value":"<string>",
"description":"(Required) Our unique identifier for the signature, returned in the [Create signature](doc:create-a-sign-request). <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"**Sandbox environment only**: Use this endpoint to start the signature flow for a test signature with a target status, using any successfully completed `verificationId`."
},
"response":[
{
"name":"202",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"deviceMetaData\": {\n \"language\": \"<string>\",\n \"model\": \"<string>\",\n \"region\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\"\n },\n \"expectation\": {\n \"status\": \"user_consent_required\",\n \"statusCode\": \"<integer>\",\n \"verificationId\": \"<string>\"\n },\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/testendpoint/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"testendpoint",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Accepted",
"code":202,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
}
]
},
{
"name":"Get test passcode",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/otp",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"otp"
],
"variable":[
{
"key":"signatureId",
"value":"<string>",
"description":"(Required) The `workflowId` returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"**Sandbox environment only**: Use this endpoint to get a one-time passcode to confirm a test signature, without requiring a valid mobile phone number. <br />The signature status must be `confirmation_required`. <br />To automate testing the signature flow, in the [Upload mobile phone number](doc:upload-mobile-phone-number) request, provide a dummy mobile phone number in the following format: +39 111111234567. You can change the digits 234567 as required."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/otp",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"otp"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"otp\": \"<string>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/otp",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"otp"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<integer>\",\n \"detail\": \"<string>\",\n \"signatureStatus\": \"<string>\"\n}"
},
{
"name":"404",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/otp",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"otp"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
},
{
"name":"503",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/otp",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"otp"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Service Unavailable",
"code":503,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
}
]
}
],
"auth":{
"type":"oauth2"
},
"variable":[
{
"key":"baseUrl",
"value":"https://api.ext-sandbox.fourthline.com"
}
]
}German solution
{
"info":{
"_postman_id":"51e08d92-6245-43fe-a16a-809970a15c1a",
"name":"German Solution: App Drop-in",
"schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id":"27570928"
},
"item":[
{
"name":"Create access token",
"request":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
},
"description":"Use this endpoint to create an access token valid for **1 hour** to authenticate requests to our API. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Make sure you address the correct [environment](doc:introduction#environments)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"token_type\": \"<string>\",\n \"access_token\": \"<string>\",\n \"expires_in\": \"<integer>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error_description\": \"<string>\",\n \"error\": \"<string>\"\n}"
}
]
},
{
"name":"Create workflow",
"request":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
},
"description":"Use this endpoint to create a workflow."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"workflowId\": \"<string>\",\n \"clientId\": \"<string>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\",\n \"errors\": [\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n}"
},
{
"name":"401",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Unauthorized",
"code":401,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error\": \"<string>\",\n \"error_description\": \"<string>\"\n}"
},
{
"name":"403",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Forbidden",
"code":403,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
},
{
"name":"500",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Internal Server Error",
"code":500,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
}
]
},
{
"name":"Upload documents to sign",
"request":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId",
"value":"<string>",
"description":"(Required) Our unique identifier for the workflow, returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint for Qualified Electronic Signature flows to upload the document(s) to sign."
},
"response":[
{
"name":"202",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Accepted",
"code":202,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"traceId\": \"<string>\",\n \"errors\": {\n \"documentsToSign\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n}"
},
{
"name":"404",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\"\n}"
},
{
"name":"409",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Conflict",
"code":409,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\"\n}"
},
{
"name":"422",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Unprocessable Entity (WebDAV) (RFC 4918)",
"code":422,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\"\n}"
}
]
},
{
"name":"Upload mobile phone number",
"request":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/data",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"data"
],
"variable":[
{
"key":"workflowId",
"value":"<string>",
"description":"(Required) Our unique identifier for the workflow, returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint for Qualified Electronic Signature flows to upload the client’s mobile phone number for the [signature confirmation step](https://docs.fourthline.com/docs/qes-overview#signature-confirmation)."
},
"response":[
{
"name":"202",
"originalRequest":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/data",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"data"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Accepted",
"code":202,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"400",
"originalRequest":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/data",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"data"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"traceId\": \"<string>\",\n \"errors\": {\n \"MobilePhoneNumber\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n}"
},
{
"name":"404",
"originalRequest":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/data",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"data"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
}
]
},
{
"name":"Create SDK session",
"request":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId",
"value":"<string>",
"description":"(Required) Our unique identifier for the workflow, returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to create an App Drop-in or Web SDK session for a workflow."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"validationCode\": \"<string>\",\n \"expiryDateTime\": \"<string>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\",\n \"errors\": [\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n}"
},
{
"name":"401",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Unauthorized",
"code":401,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error\": \"<string>\",\n \"error_description\": \"<string>\"\n}"
},
{
"name":"404",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\"\n}"
},
{
"name":"500",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Internal Server Error",
"code":500,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
}
]
},
{
"name":"Get case status",
"request":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/verificationresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"verificationresult"
],
"variable":[
{
"key":"verificationId",
"value":"<string>",
"description":"(Required) The `workflowId` returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to get the [status](https://docs.fourthline.com/docs/idv-statuses) of an Identity Verification case. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: To receive status updates automatically, set up a [webhook](https://docs.fourthline.com/docs/webhooks)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/verificationresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"verificationresult"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"verificationId\": \"<string>\",\n \"verificationStatus\": \"<string>\",\n \"dataValidationError\": {}\n}"
}
]
},
{
"name":"Get CDD PDF",
"request":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"text/plain"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:workflowId/getpdfresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":workflowId",
"getpdfresult"
],
"variable":[
{
"key":"workflowId",
"value":"<string>",
"description":"(Required) Our unique identifier for the workflow, returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to download the [CDD Report](https://docs.fourthline.com/docs/reports) in PDF format."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:workflowId/getpdfresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":workflowId",
"getpdfresult"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
}
]
},
{
"name":"Get CDD zipfile",
"request":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"text/plain"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/reports",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"reports"
],
"variable":[
{
"key":"verificationId",
"value":"<string>",
"description":"(Required) The `workflowId` returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to download a [CDD zipfile](https://docs.fourthline.com/docs/reports#identity-verification) containing the PDF CDD Report, all IDENTITY DATA in an XML file including any Fourthline corrections, and all supporting identity files. <br /><br /><img src=\"https://files.readme.io/ad2486a-Inline_Note.svg\" align=\"left\"/> **Note**: We **do not** convert media files we receive, so they are returned in the original format."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/reports",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"reports"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
}
]
},
{
"name":"Get reference payment status",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v1/referencePayments/status/:paymentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"referencePayments",
"status",
":paymentId"
],
"variable":[
{
"key":"paymentId",
"value":"<string>",
"description":"(Required) The `workflowId` returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to check the [status](https://docs.fourthline.com/docs/bav-statuses) of a Bank Account Verification reference payment. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: To receive status updates automatically, set up a [webhook](https://docs.fourthline.com/docs/webhooks)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/referencePayments/status/:paymentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"referencePayments",
"status",
":paymentId"
],
"variable":[
{
"key":"paymentId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<string>\"\n}"
},
{
"name":"404",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/referencePayments/status/:paymentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"referencePayments",
"status",
":paymentId"
],
"variable":[
{
"key":"paymentId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
}
]
},
{
"name":"Get signature status",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId",
"value":"<string>",
"description":"(Required) The `workflowId` returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to get the [status](https://docs.fourthline.com/docs/qes-statuses) of a signature flow. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: To receive status updates automatically, set up a [webhook](https://docs.fourthline.com/docs/webhooks)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<string>\",\n \"statusCode\": \"<integer>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"traceId\": \"<string>\",\n \"errors\": {\n \"signatureId\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n}"
},
{
"name":"404",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\",\n \"traceId\": \"<string>\"\n}"
}
]
},
{
"name":"Get signed documents",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"text/plain"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/signedDocuments/:documentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"signedDocuments",
":documentId"
],
"variable":[
{
"key":"signatureId",
"value":"<string>",
"description":"(Required) The `workflowId` returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
},
{
"key":"documentId",
"value":"<string>",
"description":"(Required) Your unique identifier for the signed document that you passed in the [Upload documents to sign](doc:upload-documents-to-sign) request (`documentId`)."
}
]
},
"description":"Use this endpoint to download the signed documents when the [signature status](https://docs.fourthline.com/docs/qes-statuses) changes to `signed`."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/signedDocuments/:documentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"signedDocuments",
":documentId"
],
"variable":[
{
"key":"signatureId"
},
{
"key":"documentId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{\n \"examples\": {\n \"OK\": {\n \"value\": \"HTTP/1.1 200 OK\\nDate: Thu, 09 Jun 2022 12:49:03 GMT\\nContent-Type: application/pdf\\nTransfer-Encoding: chunked\\nConnection: close\\nContent-Disposition: attachment; filename=agreement1.pdf; filename*=UTF-8''agreement1.pdf\\napi-supported-versions: 1.0\\n{{binary content of the signed document}}\"\n }\n }\n}"
},
{
"name":"400",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/signedDocuments/:documentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"signedDocuments",
":documentId"
],
"variable":[
{
"key":"signatureId"
},
{
"key":"documentId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<integer>\",\n \"detail\": \"<string>\",\n \"signatureStatus\": \"<string>\"\n}"
},
{
"name":"404",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/signedDocuments/:documentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"signedDocuments",
":documentId"
],
"variable":[
{
"key":"signatureId"
},
{
"key":"documentId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\",\n \"traceId\": \"<string>\"\n}"
}
]
},
{
"name":"Get InfoCert contract",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/qtspAgreement",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"qtspAgreement"
],
"variable":[
{
"key":"signatureId",
"value":"<string>",
"description":"(Required) Our unique identifier for the signature returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"If you have the [fallback QTSP](https://docs.fourthline.com/docs/qes-integration#qtsps) option configured, when the signature status changes to `signed`, use this endpoint to check if an InfoCert contract was generated to share with the client."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/qtspAgreement",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"qtspAgreement"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"204",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/qtspAgreement",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"qtspAgreement"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"No Content",
"code":204,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"400",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/qtspAgreement",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"qtspAgreement"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"404",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/qtspAgreement",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"qtspAgreement"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
}
]
},
{
"name":"Test signature flow",
"request":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"text/plain"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"deviceMetaData\": {\n \"language\": \"<string>\",\n \"model\": \"<string>\",\n \"region\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\"\n },\n \"expectation\": {\n \"status\": \"user_consent_required\",\n \"statusCode\": \"<integer>\",\n \"verificationId\": \"<string>\"\n },\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/testendpoint/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"testendpoint",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId",
"value":"<string>",
"description":"(Required) Our unique identifier for the signature, returned in the [Create signature](doc:create-a-sign-request). <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"**Sandbox environment only**: Use this endpoint to start the signature flow for a test signature with a target status, using any successfully completed `verificationId`."
},
"response":[
{
"name":"202",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"deviceMetaData\": {\n \"language\": \"<string>\",\n \"model\": \"<string>\",\n \"region\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\"\n },\n \"expectation\": {\n \"status\": \"user_consent_required\",\n \"statusCode\": \"<integer>\",\n \"verificationId\": \"<string>\"\n },\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/testendpoint/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"testendpoint",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Accepted",
"code":202,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
}
]
},
{
"name":"Get test passcode",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/otp",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"otp"
],
"variable":[
{
"key":"signatureId",
"value":"<string>",
"description":"(Required) The `workflowId` returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"**Sandbox environment only**: Use this endpoint to get a one-time passcode to confirm a test signature, without requiring a valid mobile phone number. <br />The signature status must be `confirmation_required`. <br />To automate testing the signature flow, in the [Upload mobile phone number](doc:upload-mobile-phone-number) request, provide a dummy mobile phone number in the following format: +39 111111234567. You can change the digits 234567 as required."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/otp",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"otp"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"otp\": \"<string>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/otp",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"otp"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<integer>\",\n \"detail\": \"<string>\",\n \"signatureStatus\": \"<string>\"\n}"
},
{
"name":"404",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/otp",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"otp"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
},
{
"name":"503",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/otp",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"otp"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Service Unavailable",
"code":503,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
}
]
}
],
"auth":{
"type":"oauth2"
},
"variable":[
{
"key":"baseUrl",
"value":"https://api.ext-sandbox.fourthline.com"
}
]
}Qualified Electronic Signature
{
"info":{
"_postman_id":"51325510-b010-4713-95fa-0d276c0dc457",
"name":"Qualified Electronic Signature: App Drop-in & Web SDK",
"schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id":"27570928"
},
"item":[
{
"name":"Create access token",
"request":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
},
"description":"Use this endpoint to create an access token valid for **1 hour** to authenticate requests to our API. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Make sure you address the correct [environment](doc:introduction#environments)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"token_type\": \"<string>\",\n \"access_token\": \"<string>\",\n \"expires_in\": \"<integer>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error_description\": \"<string>\",\n \"error\": \"<string>\"\n}"
}
]
},
{
"name":"Create workflow",
"request":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
},
"description":"Use this endpoint to create a workflow."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"workflowId\": \"<string>\",\n \"clientId\": \"<string>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\",\n \"errors\": [\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n}"
},
{
"name":"401",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Unauthorized",
"code":401,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error\": \"<string>\",\n \"error_description\": \"<string>\"\n}"
},
{
"name":"403",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Forbidden",
"code":403,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
},
{
"name":"500",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Internal Server Error",
"code":500,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
}
]
},
{
"name":"Upload documents to sign",
"request":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId",
"value":"<string>",
"description":"(Required) Our unique identifier for the workflow, returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint for Qualified Electronic Signature flows to upload the document(s) to sign."
},
"response":[
{
"name":"202",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Accepted",
"code":202,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"traceId\": \"<string>\",\n \"errors\": {\n \"documentsToSign\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n}"
},
{
"name":"404",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\"\n}"
},
{
"name":"409",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Conflict",
"code":409,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\"\n}"
},
{
"name":"422",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"documentsToSign",
"value":"[object Object]",
"description":"(Required) An array of form data objects, one for each uploaded document to sign. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: For each document, include an array in the `documentsToSign` object, or the file is ignored. <br /><br />**Required** headers: <br /> Content-Disposition: form-data; name=documentsToSign <br />Content-Type: application/json"
},
{
"key":"files",
"value":"<string>",
"description":"(Required) An array of form data files, one for each document to sign. <br /> **Required** headers: <br /> Content-Disposition: form-data; name=files; filename=filename.pdf (must match **1** filename in `documentsToSign`) <br /> Content-Type: application/pdf"
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/documentsToSign",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"documentsToSign"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Unprocessable Entity (WebDAV) (RFC 4918)",
"code":422,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\"\n}"
}
]
},
{
"name":"Upload mobile phone number",
"request":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/data",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"data"
],
"variable":[
{
"key":"workflowId",
"value":"<string>",
"description":"(Required) Our unique identifier for the workflow, returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint for Qualified Electronic Signature flows to upload the client’s mobile phone number for the [signature confirmation step](https://docs.fourthline.com/docs/qes-overview#signature-confirmation)."
},
"response":[
{
"name":"202",
"originalRequest":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/data",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"data"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Accepted",
"code":202,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"400",
"originalRequest":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/data",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"data"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"traceId\": \"<string>\",\n \"errors\": {\n \"MobilePhoneNumber\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n}"
},
{
"name":"404",
"originalRequest":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/onboarding/signatures/:workflowId/data",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"onboarding",
"signatures",
":workflowId",
"data"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
}
]
},
{
"name":"Create SDK session",
"request":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId",
"value":"<string>",
"description":"(Required) Our unique identifier for the workflow, returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to create an App Drop-in or Web SDK session for a workflow."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"validationCode\": \"<string>\",\n \"expiryDateTime\": \"<string>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\",\n \"errors\": [\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n}"
},
{
"name":"401",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Unauthorized",
"code":401,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error\": \"<string>\",\n \"error_description\": \"<string>\"\n}"
},
{
"name":"404",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\"\n}"
},
{
"name":"500",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Internal Server Error",
"code":500,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
}
]
},
{
"name":"Get signature status",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId",
"value":"<string>",
"description":"(Required) The `workflowId` returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to get the [status](https://docs.fourthline.com/docs/qes-statuses) of a signature flow. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: To receive status updates automatically, set up a [webhook](https://docs.fourthline.com/docs/webhooks)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<string>\",\n \"statusCode\": \"<integer>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"traceId\": \"<string>\",\n \"errors\": {\n \"signatureId\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n}"
},
{
"name":"404",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\",\n \"traceId\": \"<string>\"\n}"
}
]
},
{
"name":"Get signed documents",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"text/plain"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/signedDocuments/:documentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"signedDocuments",
":documentId"
],
"variable":[
{
"key":"signatureId",
"value":"<string>",
"description":"(Required) The `workflowId` returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
},
{
"key":"documentId",
"value":"<string>",
"description":"(Required) Your unique identifier for the signed document that you passed in the [Upload documents to sign](doc:upload-documents-to-sign) request (`documentId`)."
}
]
},
"description":"Use this endpoint to download the signed documents when the [signature status](https://docs.fourthline.com/docs/qes-statuses) changes to `signed`."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/signedDocuments/:documentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"signedDocuments",
":documentId"
],
"variable":[
{
"key":"signatureId"
},
{
"key":"documentId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{\n \"examples\": {\n \"OK\": {\n \"value\": \"HTTP/1.1 200 OK\\nDate: Thu, 09 Jun 2022 12:49:03 GMT\\nContent-Type: application/pdf\\nTransfer-Encoding: chunked\\nConnection: close\\nContent-Disposition: attachment; filename=agreement1.pdf; filename*=UTF-8''agreement1.pdf\\napi-supported-versions: 1.0\\n{{binary content of the signed document}}\"\n }\n }\n}"
},
{
"name":"400",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/signedDocuments/:documentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"signedDocuments",
":documentId"
],
"variable":[
{
"key":"signatureId"
},
{
"key":"documentId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<integer>\",\n \"detail\": \"<string>\",\n \"signatureStatus\": \"<string>\"\n}"
},
{
"name":"404",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/signedDocuments/:documentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"signedDocuments",
":documentId"
],
"variable":[
{
"key":"signatureId"
},
{
"key":"documentId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\",\n \"traceId\": \"<string>\"\n}"
}
]
},
{
"name":"Get InfoCert contract",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/qtspAgreement",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"qtspAgreement"
],
"variable":[
{
"key":"signatureId",
"value":"<string>",
"description":"(Required) Our unique identifier for the signature returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"If you have the [fallback QTSP](https://docs.fourthline.com/docs/qes-integration#qtsps) option configured, when the signature status changes to `signed`, use this endpoint to check if an InfoCert contract was generated to share with the client."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/qtspAgreement",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"qtspAgreement"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"204",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/qtspAgreement",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"qtspAgreement"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"No Content",
"code":204,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"400",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/qtspAgreement",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"qtspAgreement"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"404",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/qtspAgreement",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"qtspAgreement"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
}
]
},
{
"name":"Test signature flow",
"request":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"text/plain"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"deviceMetaData\": {\n \"language\": \"<string>\",\n \"model\": \"<string>\",\n \"region\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\"\n },\n \"expectation\": {\n \"status\": \"user_consent_required\",\n \"statusCode\": \"<integer>\",\n \"verificationId\": \"<string>\"\n },\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/testendpoint/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"testendpoint",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId",
"value":"<string>",
"description":"(Required) Our unique identifier for the signature, returned in the [Create signature](doc:create-a-sign-request). <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"**Sandbox environment only**: Use this endpoint to start the signature flow for a test signature with a target status, using any successfully completed `verificationId`."
},
"response":[
{
"name":"202",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"deviceMetaData\": {\n \"language\": \"<string>\",\n \"model\": \"<string>\",\n \"region\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\"\n },\n \"expectation\": {\n \"status\": \"user_consent_required\",\n \"statusCode\": \"<integer>\",\n \"verificationId\": \"<string>\"\n },\n \"mobilePhoneNumber\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/testendpoint/signatures/:signatureId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"testendpoint",
"signatures",
":signatureId"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Accepted",
"code":202,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
}
]
},
{
"name":"Get test passcode",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/otp",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"otp"
],
"variable":[
{
"key":"signatureId",
"value":"<string>",
"description":"(Required) The `workflowId` returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"**Sandbox environment only**: Use this endpoint to get a one-time passcode to confirm a test signature, without requiring a valid mobile phone number. <br />The signature status must be `confirmation_required`. <br />To automate testing the signature flow, in the [Upload mobile phone number](doc:upload-mobile-phone-number) request, provide a dummy mobile phone number in the following format: +39 111111234567. You can change the digits 234567 as required."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/otp",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"otp"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"otp\": \"<string>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/otp",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"otp"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<integer>\",\n \"detail\": \"<string>\",\n \"signatureStatus\": \"<string>\"\n}"
},
{
"name":"404",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/otp",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"otp"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
},
{
"name":"503",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/signatures/:signatureId/otp",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"signatures",
":signatureId",
"otp"
],
"variable":[
{
"key":"signatureId"
}
]
}
},
"status":"Service Unavailable",
"code":503,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
}
]
}
],
"auth":{
"type":"oauth2"
},
"variable":[
{
"key":"baseUrl",
"value":"https://api.ext-sandbox.fourthline.com"
}
]
}Bank Account Verification
{
"info":{
"_postman_id":"cec73473-636a-421b-9621-6f5eaad35472",
"name":"Bank Account Verification",
"schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id":"27570928"
},
"item":[
{
"name":"Create access token",
"request":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
},
"description":"Use this endpoint to create an access token valid for **1 hour** to authenticate requests to our API. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Make sure you address the correct [environment](doc:introduction#environments)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"token_type\": \"<string>\",\n \"access_token\": \"<string>\",\n \"expires_in\": \"<integer>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error_description\": \"<string>\",\n \"error\": \"<string>\"\n}"
}
]
},
{
"name":"Create workflow",
"request":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
},
"description":"Use this endpoint to create a workflow."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"workflowId\": \"<string>\",\n \"clientId\": \"<string>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\",\n \"errors\": [\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n}"
},
{
"name":"401",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Unauthorized",
"code":401,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error\": \"<string>\",\n \"error_description\": \"<string>\"\n}"
},
{
"name":"403",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Forbidden",
"code":403,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
},
{
"name":"500",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"workflowName\": \"<string>\",\n \"providerClientId\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows"
]
}
},
"status":"Internal Server Error",
"code":500,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
}
]
},
{
"name":"Create SDK session",
"request":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId",
"value":"<string>",
"description":"(Required) Our unique identifier for the workflow, returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to create an App Drop-in or Web SDK session for a workflow."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"validationCode\": \"<string>\",\n \"expiryDateTime\": \"<string>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\",\n \"errors\": [\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n}"
},
{
"name":"401",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Unauthorized",
"code":401,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error\": \"<string>\",\n \"error_description\": \"<string>\"\n}"
},
{
"name":"404",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\"\n}"
},
{
"name":"500",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"target\": \"Mobile\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/workflows/:workflowId/validationcode",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"workflows",
":workflowId",
"validationcode"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"Internal Server Error",
"code":500,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"detail\": \"<string>\"\n}"
}
]
},
{
"name":"Get reference payment status",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v1/referencePayments/status/:paymentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"referencePayments",
"status",
":paymentId"
],
"variable":[
{
"key":"paymentId",
"value":"<string>",
"description":"(Required) The `workflowId` returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to check the [status](https://docs.fourthline.com/docs/bav-statuses) of a Bank Account Verification reference payment. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: To receive status updates automatically, set up a [webhook](https://docs.fourthline.com/docs/webhooks)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/referencePayments/status/:paymentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"referencePayments",
"status",
":paymentId"
],
"variable":[
{
"key":"paymentId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<string>\"\n}"
},
{
"name":"404",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/referencePayments/status/:paymentId",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"referencePayments",
"status",
":paymentId"
],
"variable":[
{
"key":"paymentId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
}
]
}
],
"auth":{
"type":"oauth2"
},
"variable":[
{
"key":"baseUrl",
"value":"https://api.ext-sandbox.fourthline.com"
}
]
}AML Screening & Monitoring
{
"info":{
"_postman_id":"7396c775-c3fc-4ec3-be53-e90973748c04",
"name":"AML Screening & Monitoring",
"schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id":"27570928"
},
"item":[
{
"name":"Create access token",
"request":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
},
"description":"Use this endpoint to create an access token valid for **1 hour** to authenticate requests to our API. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Make sure you address the correct [environment](doc:introduction#environments)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"token_type\": \"<string>\",\n \"access_token\": \"<string>\",\n \"expires_in\": \"<integer>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error_description\": \"<string>\",\n \"error\": \"<string>\"\n}"
}
]
},
{
"name":"Create AML client profile",
"request":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"providerClientId\": \"<string>\",\n \"clientData\": {\n \"person\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"Male\",\n \"placeOfBirth\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"type\": \"Natural Person\",\n \"name\": \"<string>\",\n \"countryOfBirth\": \"<string>\"\n },\n \"address\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"document\": {\n \"documentNumber\": \"<string>\"\n },\n \"contact\": {\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"phone\": \"<string>\"\n }\n },\n \"monitoringType\": \"2\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v2/clients",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"clients"
]
},
"description":"Use this endpoint to create an AML client profile."
},
"response":[
{
"name":"201",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"providerClientId\": \"<string>\",\n \"clientData\": {\n \"person\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"Male\",\n \"placeOfBirth\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"type\": \"Natural Person\",\n \"name\": \"<string>\",\n \"countryOfBirth\": \"<string>\"\n },\n \"address\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"document\": {\n \"documentNumber\": \"<string>\"\n },\n \"contact\": {\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"phone\": \"<string>\"\n }\n },\n \"monitoringType\": \"2\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v2/clients",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"clients"
]
}
},
"status":"Created",
"code":201,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"id\": \"<string>\",\n \"providerClientId\": \"<string>\",\n \"clientData\": {\n \"person\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"<string>\",\n \"countryOfBirth\": \"<string>\",\n \"placeOfBirth\": \"<string>\",\n \"birthDate\": \"<string>\"\n },\n \"address\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"document\": {\n \"documentNumber\": \"<string>\"\n }\n },\n \"monitoringType\": \"<integer>\",\n \"creationUtcDateTime\": \"<string>\",\n \"updateUtcDateTime\": \"<string>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"providerClientId\": \"<string>\",\n \"clientData\": {\n \"person\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"Male\",\n \"placeOfBirth\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"type\": \"Natural Person\",\n \"name\": \"<string>\",\n \"countryOfBirth\": \"<string>\"\n },\n \"address\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"document\": {\n \"documentNumber\": \"<string>\"\n },\n \"contact\": {\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"phone\": \"<string>\"\n }\n },\n \"monitoringType\": \"2\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v2/clients",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"clients"
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"errors\": {\n \"ClientData\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ProviderClientId\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"traceId\": \"<string>\"\n}"
}
]
},
{
"name":"Start screening",
"request":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"clientIds\": [\n \"<string>\",\n \"<string>\"\n ]\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v2/WatchlistAutomation/StartSingleTimeMonitoring",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"WatchlistAutomation",
"StartSingleTimeMonitoring"
]
},
"description":"Use this endpoint to start a one-time screening for one or more AML clients (**once** per day only)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"clientIds\": [\n \"<string>\",\n \"<string>\"\n ]\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v2/WatchlistAutomation/StartSingleTimeMonitoring",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"WatchlistAutomation",
"StartSingleTimeMonitoring"
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"clientSingleTimeScreeningStatuses\": [\n {\n \"clientId\": \"<string>\",\n \"singleTimeScreeningStatus\": \"<string>\"\n },\n {\n \"clientId\": \"<string>\",\n \"singleTimeScreeningStatus\": \"<string>\"\n }\n ]\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"clientIds\": [\n \"<string>\",\n \"<string>\"\n ]\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v2/WatchlistAutomation/StartSingleTimeMonitoring",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"WatchlistAutomation",
"StartSingleTimeMonitoring"
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"errors\": {\n \"ClientIds\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n}"
},
{
"name":"422",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"clientIds\": [\n \"<string>\",\n \"<string>\"\n ]\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v2/WatchlistAutomation/StartSingleTimeMonitoring",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"WatchlistAutomation",
"StartSingleTimeMonitoring"
]
}
},
"status":"Unprocessable Entity (WebDAV) (RFC 4918)",
"code":422,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"traceId\": \"<string>\"\n}"
}
]
},
{
"name":"Get latest client hit",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v3/WatchlistAutomation/GetClientStatus/:clientId",
"host":[
"{{baseUrl}}"
],
"path":[
"v3",
"WatchlistAutomation",
"GetClientStatus",
":clientId"
],
"variable":[
{
"key":"clientId",
"value":"<string>",
"description":"(Required) Our unique identifier for the client returned in the [Create AML client profile](doc:create-aml-client) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"Use this endpoint to get the most recent hit for a specific AML client."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v3/WatchlistAutomation/GetClientStatus/:clientId",
"host":[
"{{baseUrl}}"
],
"path":[
"v3",
"WatchlistAutomation",
"GetClientStatus",
":clientId"
],
"variable":[
{
"key":"clientId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"lastProcessedDate\": \"<string>\",\n \"clientId\": \"<string>\",\n \"latestHit\": {\n \"hitId\": \"<integer>\",\n \"result\": \"<string>\",\n \"hitKind\": \"<string>\",\n \"processStartDate\": \"<string>\",\n \"processEndDate\": \"<string>\",\n \"statusCode\": 0,\n \"verificationId\": \"<string>\"\n }\n}"
},
{
"name":"400",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v3/WatchlistAutomation/GetClientStatus/:clientId",
"host":[
"{{baseUrl}}"
],
"path":[
"v3",
"WatchlistAutomation",
"GetClientStatus",
":clientId"
],
"variable":[
{
"key":"clientId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"errors\": {\n \"clientData\": [\n \"<string>\",\n \"<string>\"\n ],\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"traceId\": \"<string>\"\n }\n}"
}
]
},
{
"name":"Get all client hits",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v3/WatchlistAutomation/GetClientHits/:clientId?hitResult=validating&hitKind=sanction&hitsSinceUtc=<date>&hitsUntilUtc=<date>",
"host":[
"{{baseUrl}}"
],
"path":[
"v3",
"WatchlistAutomation",
"GetClientHits",
":clientId"
],
"query":[
{
"key":"hitResult",
"value":"validating",
"description":"Filter hits by status. <br />Enum: <br />• `confirmed_hit` <br />• `false_positive` <br />• `null` <br />• `validating`"
},
{
"key":"hitKind",
"value":"sanction",
"description":"Filter hits by type of hit. <br />Enum: <br />• null <br />• `pep` <br />• `sanction`"
},
{
"key":"hitsSinceUtc",
"value":"<date>",
"description":"Filter hits by date. <br /> Set the start date of the time frame you want to view hits for, including on this date. <br />Format: YYYY-MM-DD"
},
{
"key":"hitsUntilUtc",
"value":"<date>",
"description":"Filter hits by date. <br /> Set the end date of the time frame you want to view hits for, including on this date. <br />Format: YYYY-MM-DD"
}
],
"variable":[
{
"key":"clientId",
"value":"<string>",
"description":"(Required) Our unique identifier for the client returned in the [Create AML client profile](doc:create-aml-client) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"Use this endpoint to get a list of all hits for a specific AML client."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v3/WatchlistAutomation/GetClientHits/:clientId?hitResult=validating&hitKind=sanction&hitsSinceUtc=<date>&hitsUntilUtc=<date>",
"host":[
"{{baseUrl}}"
],
"path":[
"v3",
"WatchlistAutomation",
"GetClientHits",
":clientId"
],
"query":[
{
"key":"hitResult",
"value":"validating",
"description":"Filter hits by status. <br />Enum: <br />• `confirmed_hit` <br />• `false_positive` <br />• `null` <br />• `validating`"
},
{
"key":"hitKind",
"value":"sanction",
"description":"Filter hits by type of hit. <br />Enum: <br />• null <br />• `pep` <br />• `sanction`"
},
{
"key":"hitsSinceUtc",
"value":"<date>",
"description":"Filter hits by date. <br /> Set the start date of the time frame you want to view hits for, including on this date. <br />Format: YYYY-MM-DD"
},
{
"key":"hitsUntilUtc",
"value":"<date>",
"description":"Filter hits by date. <br /> Set the end date of the time frame you want to view hits for, including on this date. <br />Format: YYYY-MM-DD"
}
],
"variable":[
{
"key":"clientId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"clientId\": \"<string>\",\n \"hits\": [\n {\n \"hitId\": \"<integer>\",\n \"result\": \"<string>\",\n \"hitKind\": \"<string>\",\n \"processStartDate\": \"<string>\",\n \"processEndDate\": \"<string>\",\n \"statusCode\": \"<integer>\",\n \"verificationId\": \"<string>\"\n },\n {\n \"hitId\": \"<integer>\",\n \"result\": \"<string>\",\n \"hitKind\": \"<string>\",\n \"processStartDate\": \"<string>\",\n \"processEndDate\": \"<string>\",\n \"statusCode\": \"<integer>\",\n \"verificationId\": \"<string>\"\n }\n ]\n}"
}
]
},
{
"name":"Get investigation hits",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v3/WatchlistAutomation/GetVerificationHits/:verificationId",
"host":[
"{{baseUrl}}"
],
"path":[
"v3",
"WatchlistAutomation",
"GetVerificationHits",
":verificationId"
],
"variable":[
{
"key":"verificationId",
"value":"<string>",
"description":"(Required) The unique identifier for the investigation, returned in any [Get latest client hit](doc:get-latest-client-hit), [Get all client hits](doc:get-all-client-hits), or [Get investigation hits](doc:get-investigation-hits) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"Use this endpoint to get all hits for a specific AML investigation. <br /><br /><img src=\"https://files.readme.io/ad2486a-Inline_Note.svg\" align=\"left\"/> **Note**: Multiple investigations can be linked to a single AML client."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v3/WatchlistAutomation/GetVerificationHits/:verificationId",
"host":[
"{{baseUrl}}"
],
"path":[
"v3",
"WatchlistAutomation",
"GetVerificationHits",
":verificationId"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"hitId\": \"<integer>\",\n \"result\": \"<string>\",\n \"hitKind\": \"<string>\",\n \"processStartDate\": \"<string>\",\n \"processEndDate\": \"<string>\",\n \"statusCode\": \"<integer>\",\n \"verificationId\": \"<string>\"\n}"
}
]
},
{
"name":"Get Confirmed Hit Report",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/getpdfresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"getpdfresult"
],
"variable":[
{
"key":"verificationId",
"value":"<string>",
"description":"(Required) Our unique identifier for the AML investigation, returned in the [Get latest client hit](doc:get-latest-client-hit) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"Use this endpoint to download the [Confirmed Hit Report](https://docs.fourthline.com/docs/reports#aml-report) for an AML Investigation. <br /><br /><img src=\"https://files.readme.io/ad2486a-Inline_Note.svg\" align=\"left\"/> **Note**: To make this request, you must first make a [Get latest client hit](doc:get-latest-client-hit) request to get the investigation identifier."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/getpdfresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"getpdfresult"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
}
]
},
{
"name":"Get AML client by your ID",
"request":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v2/clients/ProviderClientId/:providerClientId?tenant=<string>",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"clients",
"ProviderClientId",
":providerClientId"
],
"query":[
{
"key":"tenant",
"value":"<string>",
"description":"Your unique identifier."
}
],
"variable":[
{
"key":"providerClientId",
"value":"<string>",
"description":"(Required) Your unique identifier for the client that you passed in the [Create AML client profile](doc:create-aml-client) request."
}
]
},
"description":"Use this endpoint to get an AML client profile using **your** identifier: `providerClientId`."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v2/clients/ProviderClientId/:providerClientId?tenant=<string>",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"clients",
"ProviderClientId",
":providerClientId"
],
"query":[
{
"key":"tenant",
"value":"<string>",
"description":"Your unique identifier."
}
],
"variable":[
{
"key":"providerClientId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"id\": \"<string>\",\n \"providerClientId\": \"<string>\",\n \"clientData\": {\n \"person\": {\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"initials\": \"<string>\",\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"<string>\",\n \"countryOfBirth\": \"<string>\",\n \"placeOfBirth\": \"<string>\",\n \"birthDate\": \"<string>\"\n },\n \"address\": {\n \"street\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"region\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"contact\": {\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"mobile\": \"<string>\"\n },\n \"document\": {\n \"documentNumber\": \"<string>\"\n },\n \"monitoringType\": \"<integer>\",\n \"creationUtcDateTime\": \"<string>\",\n \"updateUtcDateTime\": \"<string>\"\n }\n}"
}
]
},
{
"name":"Get AML client by our ID",
"request":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v2/clients/:id?tenant=<string>",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"clients",
":id"
],
"query":[
{
"key":"tenant",
"value":"<string>",
"description":"Your unique identifier."
}
],
"variable":[
{
"key":"id",
"value":"<string>",
"description":"(Required) Our unique identifier for the client returned in the [Create AML client profile](doc:create-aml-client) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"Use this endpoint to get an AML client profile using Fourthline's identifier: `id`."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v2/clients/:id?tenant=<string>",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"clients",
":id"
],
"query":[
{
"key":"tenant",
"value":"<string>",
"description":"Your unique identifier."
}
],
"variable":[
{
"key":"id"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"id\": \"<string>\",\n \"providerClientId\": \"<string>\",\n \"clientData\": {\n \"person\": {\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"initials\": \"<string>\",\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"<string>\",\n \"countryOfBirth\": \"<string>\",\n \"placeOfBirth\": \"<string>\",\n \"birthDate\": \"<string>\"\n },\n \"address\": {\n \"street\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"region\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"contact\": {\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"mobile\": \"<string>\"\n },\n \"document\": {\n \"documentNumber\": \"<string>\"\n },\n \"monitoringType\": \"<integer>\",\n \"creationUtcDateTime\": \"<string>\",\n \"updateUtcDateTime\": \"<string>\"\n }\n}"
}
]
},
{
"name":"Update AML client",
"request":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"clientData\": {\n \"person\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"Unknown\",\n \"placeOfBirth\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"type\": \"Natural Person\",\n \"name\": \"<string>\",\n \"initials\": \"<string>\",\n \"middleName\": \"<string>\",\n \"countryOfBirth\": \"<string>\"\n },\n \"address\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"document\": {\n \"documentNumber\": \"<string>\"\n },\n \"contact\": {\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"mobile\": \"<string>\"\n }\n },\n \"monitoringType\": \"<integer>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v2/clients/:id",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"clients",
":id"
],
"variable":[
{
"key":"id",
"value":"<string>",
"description":"(Required) Our unique identifier for the client returned in the [Create AML client profile](doc:create-aml-client) response.<br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"Use this endpoint to update an AML client profile."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"clientData\": {\n \"person\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"Unknown\",\n \"placeOfBirth\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"type\": \"Natural Person\",\n \"name\": \"<string>\",\n \"initials\": \"<string>\",\n \"middleName\": \"<string>\",\n \"countryOfBirth\": \"<string>\"\n },\n \"address\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"document\": {\n \"documentNumber\": \"<string>\"\n },\n \"contact\": {\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"mobile\": \"<string>\"\n }\n },\n \"monitoringType\": \"<integer>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v2/clients/:id",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"clients",
":id"
],
"variable":[
{
"key":"id"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"examples\": {\n \"OK\": {\n \"value\": \"{\\n \\\"id\\\":\\\"790f325a-48c9-4b82-bb53-c0ea128236f0\\\",\\n \\\"branch\\\":\\\"{TENANT_BRANCH}\\\",\\n \\\"providerClientId\\\":\\\"your-client-id\\\",\\n \\\"clientData\\\":{\\n \\\"person\\\":{\\n \\\"firstName\\\":\\\"John\\\",\\n \\\"middleName\\\":\\\"James\\\",\\n \\\"lastName\\\":\\\"Smith\\\",\\n \\\"nationality\\\":\\\"NLD\\\",\\n \\\"gender\\\":\\\"Female\\\",\\n \\\"countryOfBirth\\\":\\\"NLD\\\",\\n \\\"placeOfBirth\\\":\\\"Amsterdam\\\",\\n \\\"birthDate\\\":\\\"1965-10-03T00:00:00\\\"\\n },\\n \\\"address\\\":{\\n \\\"city\\\":\\\"Amsterdam\\\",\\n \\\"country\\\":\\\"NLD\\\"\\n },\\n \\\"document\\\":{\\n \\\"documentNumber\\\":\\\"{DOCUMENT_NUMBER}\\\"\\n }\\n },\\n \\\"monitoringType\\\":2,\\n \\\"creationUtcDateTime\\\":\\\"2020-12-28T13:57:22.9931256Z\\\",\\n \\\"updateUtcDateTime\\\":\\\"2020-12-28T13:57:22.9931272Z\\\"\\n} \"\n }\n }\n}"
},
{
"name":"400",
"originalRequest":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"clientData\": {\n \"person\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"Unknown\",\n \"placeOfBirth\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"type\": \"Natural Person\",\n \"name\": \"<string>\",\n \"initials\": \"<string>\",\n \"middleName\": \"<string>\",\n \"countryOfBirth\": \"<string>\"\n },\n \"address\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"document\": {\n \"documentNumber\": \"<string>\"\n },\n \"contact\": {\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"mobile\": \"<string>\"\n }\n },\n \"monitoringType\": \"<integer>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v2/clients/:id",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"clients",
":id"
],
"variable":[
{
"key":"id"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"errors\": {\n \"ClientData\": [\n \"<string>\",\n \"<string>\"\n ],\n \"ProviderClientId\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\",\n \"traceId\": \"<string>\"\n}"
}
]
},
{
"name":"Deactivate AML client",
"request":{
"method":"DELETE",
"header":[
{
"key":"Accept",
"value":"text/plain"
}
],
"url":{
"raw":"{{baseUrl}}/v2/clients/:id?tenant=<string>",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"clients",
":id"
],
"query":[
{
"key":"tenant",
"value":"<string>",
"description":"Your unique identifier."
}
],
"variable":[
{
"key":"id",
"value":"<string>",
"description":"(Required) Our unique identifier for the client returned in the [Create AML client profile](doc:create-aml-client) response.<br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"Use this endpoint to deactivate an AML client profile (no data is deleted)."
},
"response":[
{
"name":"204",
"originalRequest":{
"method":"DELETE",
"header":[
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v2/clients/:id?tenant=<string>",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"clients",
":id"
],
"query":[
{
"key":"tenant",
"value":"<string>",
"description":"Your unique identifier."
}
],
"variable":[
{
"key":"id"
}
]
}
},
"status":"No Content",
"code":204,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{\n \"examples\": {\n \"No content\": {\n \"value\": \"Response headers:\\ndate: Mon18 Oct 2021 07:46:24 GMT \\nserver: Kestrel \"\n }\n }\n}"
},
{
"name":"404",
"originalRequest":{
"method":"DELETE",
"header":[
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v2/clients/:id?tenant=<string>",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"clients",
":id"
],
"query":[
{
"key":"tenant",
"value":"<string>",
"description":"Your unique identifier."
}
],
"variable":[
{
"key":"id"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
}
]
}
],
"auth":{
"type":"oauth2"
},
"variable":[
{
"key":"baseUrl",
"value":"https://api.ext-sandbox.fourthline.com"
}
]
}Client Authentication
{
"info":{
"_postman_id":"9585be16-87fa-4b05-8f00-cd166647cdf2",
"name":"Client Authentication",
"schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id":"27570928"
},
"item":[
{
"name":"Create access token",
"request":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
},
"description":"Use this endpoint to create an access token valid for **1 hour** to authenticate requests to our API. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Make sure you address the correct [environment](doc:introduction#environments)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"token_type\": \"<string>\",\n \"access_token\": \"<string>\",\n \"expires_in\": \"<integer>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error_description\": \"<string>\",\n \"error\": \"<string>\"\n}"
}
]
},
{
"name":"Create Client Authentication",
"request":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"providerProcessId\": \"<string>\",\n \"processType\": \"ClientConfirmation\",\n \"branch\": \"<string>\",\n \"clientData\": {\n \"person\": {\n \"type\": \"Natural Person\",\n \"name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"Other\",\n \"birthDate\": \"<date>\",\n \"placeOfBirth\": \"<string>\",\n \"initials\": \"<string>\",\n \"middleName\": \"<string>\",\n \"countryOfBirth\": \"<string>\"\n },\n \"address\": {\n \"street\": \"<string>\",\n \"streetNumber\": \"<integer>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"emailAndPhone\": {\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"tax\": {\n \"countrySubjectToTaxation\": \"<string>\",\n \"tin\": \"<string>\",\n \"usPerson\": \"<string>\",\n \"usTin\": \"<string>\"\n },\n \"profession\": {\n \"employment\": \"yes\",\n \"professionName\": \"<string>\",\n \"industry\": \"L\"\n },\n \"riskRequirements\": {\n \"entity\": \"ITA\",\n \"pepSelfDeclared\": \"no\",\n \"placeOfWork\": \"<string>\",\n \"product\": \"<string>\",\n \"sector\": \"<string>\",\n \"sourceOfIncome\": \"<string>\"\n },\n \"deviceMetaData\": {\n \"browserType\": \"<string>\",\n \"browserVersion\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"language\": \"<string>\",\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"model\": \"<string>\",\n \"osCompromised\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"region\": \"<string>\",\n \"sdkVersion\": \"<string>\",\n \"analyticsId\": \"<string>\"\n },\n \"previousDocumentData\": {\n \"BirthDate\": \"<date>\",\n \"FirstName\": \"<string>\",\n \"LastName\": \"<string>\",\n \"Nationality\": \"<string>\",\n \"PlaceOfBirth\": \"<string>\"\n }\n }\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/clients/:clientId/verifications (ClientConfirmation)",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"clients",
":clientId",
"verifications (ClientConfirmation)"
],
"variable":[
{
"key":"clientId",
"value":"<string>",
"description":"(Required) Our unique identifier for the client returned in the [Create workflow](doc:create-workflow) response.<br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"Use this endpoint to create a Client Authentication case with the `clientId` from a previous successful Identity Verification case."
},
"response":[
{
"name":"201",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"providerProcessId\": \"<string>\",\n \"processType\": \"ClientConfirmation\",\n \"branch\": \"<string>\",\n \"clientData\": {\n \"person\": {\n \"type\": \"Natural Person\",\n \"name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"Other\",\n \"birthDate\": \"<date>\",\n \"placeOfBirth\": \"<string>\",\n \"initials\": \"<string>\",\n \"middleName\": \"<string>\",\n \"countryOfBirth\": \"<string>\"\n },\n \"address\": {\n \"street\": \"<string>\",\n \"streetNumber\": \"<integer>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"emailAndPhone\": {\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"tax\": {\n \"countrySubjectToTaxation\": \"<string>\",\n \"tin\": \"<string>\",\n \"usPerson\": \"<string>\",\n \"usTin\": \"<string>\"\n },\n \"profession\": {\n \"employment\": \"yes\",\n \"professionName\": \"<string>\",\n \"industry\": \"L\"\n },\n \"riskRequirements\": {\n \"entity\": \"ITA\",\n \"pepSelfDeclared\": \"no\",\n \"placeOfWork\": \"<string>\",\n \"product\": \"<string>\",\n \"sector\": \"<string>\",\n \"sourceOfIncome\": \"<string>\"\n },\n \"deviceMetaData\": {\n \"browserType\": \"<string>\",\n \"browserVersion\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"language\": \"<string>\",\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"model\": \"<string>\",\n \"osCompromised\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"region\": \"<string>\",\n \"sdkVersion\": \"<string>\",\n \"analyticsId\": \"<string>\"\n },\n \"previousDocumentData\": {\n \"BirthDate\": \"<date>\",\n \"FirstName\": \"<string>\",\n \"LastName\": \"<string>\",\n \"Nationality\": \"<string>\",\n \"PlaceOfBirth\": \"<string>\"\n }\n }\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/clients/:clientId/verifications (ClientConfirmation)",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"clients",
":clientId",
"verifications (ClientConfirmation)"
],
"variable":[
{
"key":"clientId"
}
]
}
},
"status":"Created",
"code":201,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"verificationId\": \"<string>\",\n \"providerProcessId\": \"<string>\",\n \"status\": \"<string>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"providerProcessId\": \"<string>\",\n \"processType\": \"ClientConfirmation\",\n \"branch\": \"<string>\",\n \"clientData\": {\n \"person\": {\n \"type\": \"Natural Person\",\n \"name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"Other\",\n \"birthDate\": \"<date>\",\n \"placeOfBirth\": \"<string>\",\n \"initials\": \"<string>\",\n \"middleName\": \"<string>\",\n \"countryOfBirth\": \"<string>\"\n },\n \"address\": {\n \"street\": \"<string>\",\n \"streetNumber\": \"<integer>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"emailAndPhone\": {\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"tax\": {\n \"countrySubjectToTaxation\": \"<string>\",\n \"tin\": \"<string>\",\n \"usPerson\": \"<string>\",\n \"usTin\": \"<string>\"\n },\n \"profession\": {\n \"employment\": \"yes\",\n \"professionName\": \"<string>\",\n \"industry\": \"L\"\n },\n \"riskRequirements\": {\n \"entity\": \"ITA\",\n \"pepSelfDeclared\": \"no\",\n \"placeOfWork\": \"<string>\",\n \"product\": \"<string>\",\n \"sector\": \"<string>\",\n \"sourceOfIncome\": \"<string>\"\n },\n \"deviceMetaData\": {\n \"browserType\": \"<string>\",\n \"browserVersion\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"language\": \"<string>\",\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"model\": \"<string>\",\n \"osCompromised\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"region\": \"<string>\",\n \"sdkVersion\": \"<string>\",\n \"analyticsId\": \"<string>\"\n },\n \"previousDocumentData\": {\n \"BirthDate\": \"<date>\",\n \"FirstName\": \"<string>\",\n \"LastName\": \"<string>\",\n \"Nationality\": \"<string>\",\n \"PlaceOfBirth\": \"<string>\"\n }\n }\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/clients/:clientId/verifications (ClientConfirmation)",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"clients",
":clientId",
"verifications (ClientConfirmation)"
],
"variable":[
{
"key":"clientId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\",\n \"errors\": [\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n}"
},
{
"name":"404",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"providerProcessId\": \"<string>\",\n \"processType\": \"ClientConfirmation\",\n \"branch\": \"<string>\",\n \"clientData\": {\n \"person\": {\n \"type\": \"Natural Person\",\n \"name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"Other\",\n \"birthDate\": \"<date>\",\n \"placeOfBirth\": \"<string>\",\n \"initials\": \"<string>\",\n \"middleName\": \"<string>\",\n \"countryOfBirth\": \"<string>\"\n },\n \"address\": {\n \"street\": \"<string>\",\n \"streetNumber\": \"<integer>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"emailAndPhone\": {\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"tax\": {\n \"countrySubjectToTaxation\": \"<string>\",\n \"tin\": \"<string>\",\n \"usPerson\": \"<string>\",\n \"usTin\": \"<string>\"\n },\n \"profession\": {\n \"employment\": \"yes\",\n \"professionName\": \"<string>\",\n \"industry\": \"L\"\n },\n \"riskRequirements\": {\n \"entity\": \"ITA\",\n \"pepSelfDeclared\": \"no\",\n \"placeOfWork\": \"<string>\",\n \"product\": \"<string>\",\n \"sector\": \"<string>\",\n \"sourceOfIncome\": \"<string>\"\n },\n \"deviceMetaData\": {\n \"browserType\": \"<string>\",\n \"browserVersion\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"language\": \"<string>\",\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"model\": \"<string>\",\n \"osCompromised\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"region\": \"<string>\",\n \"sdkVersion\": \"<string>\",\n \"analyticsId\": \"<string>\"\n },\n \"previousDocumentData\": {\n \"BirthDate\": \"<date>\",\n \"FirstName\": \"<string>\",\n \"LastName\": \"<string>\",\n \"Nationality\": \"<string>\",\n \"PlaceOfBirth\": \"<string>\"\n }\n }\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/clients/:clientId/verifications (ClientConfirmation)",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"clients",
":clientId",
"verifications (ClientConfirmation)"
],
"variable":[
{
"key":"clientId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"422",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"providerProcessId\": \"<string>\",\n \"processType\": \"ClientConfirmation\",\n \"branch\": \"<string>\",\n \"clientData\": {\n \"person\": {\n \"type\": \"Natural Person\",\n \"name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"Other\",\n \"birthDate\": \"<date>\",\n \"placeOfBirth\": \"<string>\",\n \"initials\": \"<string>\",\n \"middleName\": \"<string>\",\n \"countryOfBirth\": \"<string>\"\n },\n \"address\": {\n \"street\": \"<string>\",\n \"streetNumber\": \"<integer>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"emailAndPhone\": {\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"tax\": {\n \"countrySubjectToTaxation\": \"<string>\",\n \"tin\": \"<string>\",\n \"usPerson\": \"<string>\",\n \"usTin\": \"<string>\"\n },\n \"profession\": {\n \"employment\": \"yes\",\n \"professionName\": \"<string>\",\n \"industry\": \"L\"\n },\n \"riskRequirements\": {\n \"entity\": \"ITA\",\n \"pepSelfDeclared\": \"no\",\n \"placeOfWork\": \"<string>\",\n \"product\": \"<string>\",\n \"sector\": \"<string>\",\n \"sourceOfIncome\": \"<string>\"\n },\n \"deviceMetaData\": {\n \"browserType\": \"<string>\",\n \"browserVersion\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"language\": \"<string>\",\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"model\": \"<string>\",\n \"osCompromised\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"region\": \"<string>\",\n \"sdkVersion\": \"<string>\",\n \"analyticsId\": \"<string>\"\n },\n \"previousDocumentData\": {\n \"BirthDate\": \"<date>\",\n \"FirstName\": \"<string>\",\n \"LastName\": \"<string>\",\n \"Nationality\": \"<string>\",\n \"PlaceOfBirth\": \"<string>\"\n }\n }\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/clients/:clientId/verifications (ClientConfirmation)",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"clients",
":clientId",
"verifications (ClientConfirmation)"
],
"variable":[
{
"key":"clientId"
}
]
}
},
"status":"Unprocessable Entity (WebDAV) (RFC 4918)",
"code":422,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
}
]
},
{
"name":"Process Client Authentication",
"request":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"Selfie",
"value":"<string>",
"description":"(Required) The client’s selfie photo. <br />Format: Binary jpeg image"
},
{
"key":"SelfieVideo",
"value":"<string>",
"description":"(Required) The client’s selfie video.<br />Format: Binary mp4 video file of less than 10 seconds with .mp4 file name extension"
},
{
"key":"DeviceMetaData",
"value":"[object Object]",
"description":"(Required) The client’s device metadata."
}
]
},
"url":{
"raw":"{{baseUrl}}/ccr/v1/verifications/:verificationId/confirmclient",
"host":[
"{{baseUrl}}"
],
"path":[
"ccr",
"v1",
"verifications",
":verificationId",
"confirmclient"
],
"variable":[
{
"key":"verificationId",
"value":"<string>",
"description":"(Required) Our unique identifier for the case, returned in the [Create Client Authentication](doc:create-identity-verification-copy) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to trigger processing of a Client Authentication case."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"Selfie",
"value":"<string>",
"description":"(Required) The client’s selfie photo. <br />Format: Binary jpeg image"
},
{
"key":"SelfieVideo",
"value":"<string>",
"description":"(Required) The client’s selfie video.<br />Format: Binary mp4 video file of less than 10 seconds with .mp4 file name extension"
},
{
"key":"DeviceMetaData",
"value":"[object Object]",
"description":"(Required) The client’s device metadata."
}
]
},
"url":{
"raw":"{{baseUrl}}/ccr/v1/verifications/:verificationId/confirmclient",
"host":[
"{{baseUrl}}"
],
"path":[
"ccr",
"v1",
"verifications",
":verificationId",
"confirmclient"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"status\": \"<string>\",\n \"providerProcessId\": \"<string>\",\n \"created\": \"<string>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"Selfie",
"value":"<string>",
"description":"(Required) The client’s selfie photo. <br />Format: Binary jpeg image"
},
{
"key":"SelfieVideo",
"value":"<string>",
"description":"(Required) The client’s selfie video.<br />Format: Binary mp4 video file of less than 10 seconds with .mp4 file name extension"
},
{
"key":"DeviceMetaData",
"value":"[object Object]",
"description":"(Required) The client’s device metadata."
}
]
},
"url":{
"raw":"{{baseUrl}}/ccr/v1/verifications/:verificationId/confirmclient",
"host":[
"{{baseUrl}}"
],
"path":[
"ccr",
"v1",
"verifications",
":verificationId",
"confirmclient"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"errors\": {\n \"selfie\": [\n \"<string>\",\n \"<string>\"\n ],\n \"selfieVideo\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"status\": \"<integer>\"\n}"
},
{
"name":"404",
"originalRequest":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"Selfie",
"value":"<string>",
"description":"(Required) The client’s selfie photo. <br />Format: Binary jpeg image"
},
{
"key":"SelfieVideo",
"value":"<string>",
"description":"(Required) The client’s selfie video.<br />Format: Binary mp4 video file of less than 10 seconds with .mp4 file name extension"
},
{
"key":"DeviceMetaData",
"value":"[object Object]",
"description":"(Required) The client’s device metadata."
}
]
},
"url":{
"raw":"{{baseUrl}}/ccr/v1/verifications/:verificationId/confirmclient",
"host":[
"{{baseUrl}}"
],
"path":[
"ccr",
"v1",
"verifications",
":verificationId",
"confirmclient"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"422",
"originalRequest":{
"method":"PUT",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"Selfie",
"value":"<string>",
"description":"(Required) The client’s selfie photo. <br />Format: Binary jpeg image"
},
{
"key":"SelfieVideo",
"value":"<string>",
"description":"(Required) The client’s selfie video.<br />Format: Binary mp4 video file of less than 10 seconds with .mp4 file name extension"
},
{
"key":"DeviceMetaData",
"value":"[object Object]",
"description":"(Required) The client’s device metadata."
}
]
},
"url":{
"raw":"{{baseUrl}}/ccr/v1/verifications/:verificationId/confirmclient",
"host":[
"{{baseUrl}}"
],
"path":[
"ccr",
"v1",
"verifications",
":verificationId",
"confirmclient"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"Unprocessable Entity (WebDAV) (RFC 4918)",
"code":422,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{\n \"examples\": {\n \"Invalid processType\": {\n \"value\": \"The process type of the verification is not allowed for this action.\"\n },\n \"Invalid data in form\": {\n \"value\": \"Selfie : The document NLD.selfie.front.0.jpg is not a valid image\\nSelfieVideo : Video document NLD.selfie.jpg is not an MP4 file.\\nCcrJson : The document CcrJson.json has the following errors: NoTypeValidates: #/DeviceMetaData.Language\\n{Null:\\n PatternMismatch: #/DeviceMetaData.Language\\n StringTooLong: #/DeviceMetaData.Language\\n NullExpected: #/DeviceMetaData.Language\\n}\\n{String:\\n PatternMismatch: #/DeviceMetaData.Language\\n StringTooLong: #/DeviceMetaData.Language\\n}\"\n }\n }\n}"
}
]
},
{
"name":"Get Client Authentication status",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/clientconfirmationresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"clientconfirmationresult"
],
"variable":[
{
"key":"verificationId",
"value":"<string>",
"description":"(Required) Our unique identifier for the case, returned in the [Create Client Authentication](doc:create-identity-verification-copy) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to get the [status](https://docs.fourthline.com/docs/biometricauth-statuses) of a Biometric Authentication case. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: To receive status updates automatically, set up a [webhook](https://docs.fourthline.com/docs/webhooks)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/clientconfirmationresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"clientconfirmationresult"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"data\": {\n \"analyst\": \"<string>\"\n },\n \"verificationId\": \"<string>\",\n \"processType\": \"<string>\",\n \"verificationStatus\": \"<string>\",\n \"riskInfo\": {\n \"statusCode\": \"<integer>\",\n \"description\": \"<string>\"\n }\n}"
}
]
},
{
"name":"Get CDD PDF",
"request":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"text/plain"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:workflowId/getpdfresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":workflowId",
"getpdfresult"
],
"variable":[
{
"key":"workflowId",
"value":"<string>",
"description":"(Required) Our unique identifier for the workflow, returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to download the [CDD Report](https://docs.fourthline.com/docs/reports) in PDF format."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:workflowId/getpdfresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":workflowId",
"getpdfresult"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
}
]
}
],
"auth":{
"type":"oauth2"
},
"variable":[
{
"key":"baseUrl",
"value":"https://api.ext-sandbox.fourthline.com"
}
]
}Document Authentication
{
"info":{
"_postman_id":"145139dd-4c92-4165-9015-d4965ffec68e",
"name":"Document Authentication",
"schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id":"27570928"
},
"item":[
{
"name":"Create access token",
"request":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
},
"description":"Use this endpoint to create an access token valid for **1 hour** to authenticate requests to our API. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Make sure you address the correct [environment](doc:introduction#environments)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"token_type\": \"<string>\",\n \"access_token\": \"<string>\",\n \"expires_in\": \"<integer>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\"\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/oauth2/token",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"oauth2",
"token"
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"error_description\": \"<string>\",\n \"error\": \"<string>\"\n}"
}
]
},
{
"name":"Create Document Authentication",
"request":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"providerProcessId\": \"<string>\",\n \"processType\": \"ClientDocumentRenewal\",\n \"branch\": \"<string>\",\n \"clientData\": {\n \"person\": {\n \"type\": \"Natural Person\",\n \"name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"Female\",\n \"birthDate\": \"<date>\",\n \"placeOfBirth\": \"<string>\",\n \"initials\": \"<string>\",\n \"middleName\": \"<string>\",\n \"countryOfBirth\": \"<string>\"\n },\n \"address\": {\n \"street\": \"<string>\",\n \"streetNumber\": \"<integer>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"emailAndPhone\": {\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"tax\": {\n \"countrySubjectToTaxation\": \"<string>\",\n \"tin\": \"<string>\",\n \"usPerson\": \"<string>\",\n \"usTin\": \"<string>\"\n },\n \"profession\": {\n \"employment\": \"self-employed\",\n \"professionName\": \"<string>\",\n \"industry\": \"Q\"\n },\n \"riskRequirements\": {\n \"entity\": \"ITA\",\n \"pepSelfDeclared\": \"yes\",\n \"placeOfWork\": \"<string>\",\n \"product\": \"<string>\",\n \"sector\": \"<string>\",\n \"sourceOfIncome\": \"<string>\"\n },\n \"deviceMetaData\": {\n \"browserType\": \"<string>\",\n \"browserVersion\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"language\": \"<string>\",\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"model\": \"<string>\",\n \"osCompromised\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"region\": \"<string>\",\n \"sdkVersion\": \"<string>\",\n \"analyticsId\": \"<string>\"\n },\n \"previousDocumentData\": {\n \"BirthDate\": \"<date>\",\n \"FirstName\": \"<string>\",\n \"LastName\": \"<string>\",\n \"Nationality\": \"<string>\",\n \"PlaceOfBirth\": \"<string>\"\n }\n }\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/clients/:clientId/verifications (DocumentAuthentication)",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"clients",
":clientId",
"verifications (DocumentAuthentication)"
],
"variable":[
{
"key":"clientId",
"value":"<string>",
"description":"(Required) Our unique identifier for the client returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`"
}
]
},
"description":"Use this endpoint to create a Document Authentication case with the `clientId` from a previous successful Identity Verification case."
},
"response":[
{
"name":"201",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"providerProcessId\": \"<string>\",\n \"processType\": \"ClientDocumentRenewal\",\n \"branch\": \"<string>\",\n \"clientData\": {\n \"person\": {\n \"type\": \"Natural Person\",\n \"name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"Female\",\n \"birthDate\": \"<date>\",\n \"placeOfBirth\": \"<string>\",\n \"initials\": \"<string>\",\n \"middleName\": \"<string>\",\n \"countryOfBirth\": \"<string>\"\n },\n \"address\": {\n \"street\": \"<string>\",\n \"streetNumber\": \"<integer>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"emailAndPhone\": {\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"tax\": {\n \"countrySubjectToTaxation\": \"<string>\",\n \"tin\": \"<string>\",\n \"usPerson\": \"<string>\",\n \"usTin\": \"<string>\"\n },\n \"profession\": {\n \"employment\": \"self-employed\",\n \"professionName\": \"<string>\",\n \"industry\": \"Q\"\n },\n \"riskRequirements\": {\n \"entity\": \"ITA\",\n \"pepSelfDeclared\": \"yes\",\n \"placeOfWork\": \"<string>\",\n \"product\": \"<string>\",\n \"sector\": \"<string>\",\n \"sourceOfIncome\": \"<string>\"\n },\n \"deviceMetaData\": {\n \"browserType\": \"<string>\",\n \"browserVersion\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"language\": \"<string>\",\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"model\": \"<string>\",\n \"osCompromised\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"region\": \"<string>\",\n \"sdkVersion\": \"<string>\",\n \"analyticsId\": \"<string>\"\n },\n \"previousDocumentData\": {\n \"BirthDate\": \"<date>\",\n \"FirstName\": \"<string>\",\n \"LastName\": \"<string>\",\n \"Nationality\": \"<string>\",\n \"PlaceOfBirth\": \"<string>\"\n }\n }\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/clients/:clientId/verifications (DocumentAuthentication)",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"clients",
":clientId",
"verifications (DocumentAuthentication)"
],
"variable":[
{
"key":"clientId"
}
]
}
},
"status":"Created",
"code":201,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"verificationId\": \"<string>\",\n \"providerProcessId\": \"<string>\",\n \"status\": \"<string>\"\n}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"providerProcessId\": \"<string>\",\n \"processType\": \"ClientDocumentRenewal\",\n \"branch\": \"<string>\",\n \"clientData\": {\n \"person\": {\n \"type\": \"Natural Person\",\n \"name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"Female\",\n \"birthDate\": \"<date>\",\n \"placeOfBirth\": \"<string>\",\n \"initials\": \"<string>\",\n \"middleName\": \"<string>\",\n \"countryOfBirth\": \"<string>\"\n },\n \"address\": {\n \"street\": \"<string>\",\n \"streetNumber\": \"<integer>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"emailAndPhone\": {\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"tax\": {\n \"countrySubjectToTaxation\": \"<string>\",\n \"tin\": \"<string>\",\n \"usPerson\": \"<string>\",\n \"usTin\": \"<string>\"\n },\n \"profession\": {\n \"employment\": \"self-employed\",\n \"professionName\": \"<string>\",\n \"industry\": \"Q\"\n },\n \"riskRequirements\": {\n \"entity\": \"ITA\",\n \"pepSelfDeclared\": \"yes\",\n \"placeOfWork\": \"<string>\",\n \"product\": \"<string>\",\n \"sector\": \"<string>\",\n \"sourceOfIncome\": \"<string>\"\n },\n \"deviceMetaData\": {\n \"browserType\": \"<string>\",\n \"browserVersion\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"language\": \"<string>\",\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"model\": \"<string>\",\n \"osCompromised\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"region\": \"<string>\",\n \"sdkVersion\": \"<string>\",\n \"analyticsId\": \"<string>\"\n },\n \"previousDocumentData\": {\n \"BirthDate\": \"<date>\",\n \"FirstName\": \"<string>\",\n \"LastName\": \"<string>\",\n \"Nationality\": \"<string>\",\n \"PlaceOfBirth\": \"<string>\"\n }\n }\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/clients/:clientId/verifications (DocumentAuthentication)",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"clients",
":clientId",
"verifications (DocumentAuthentication)"
],
"variable":[
{
"key":"clientId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\",\n \"errors\": [\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n}"
},
{
"name":"404",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"providerProcessId\": \"<string>\",\n \"processType\": \"ClientDocumentRenewal\",\n \"branch\": \"<string>\",\n \"clientData\": {\n \"person\": {\n \"type\": \"Natural Person\",\n \"name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"Female\",\n \"birthDate\": \"<date>\",\n \"placeOfBirth\": \"<string>\",\n \"initials\": \"<string>\",\n \"middleName\": \"<string>\",\n \"countryOfBirth\": \"<string>\"\n },\n \"address\": {\n \"street\": \"<string>\",\n \"streetNumber\": \"<integer>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"emailAndPhone\": {\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"tax\": {\n \"countrySubjectToTaxation\": \"<string>\",\n \"tin\": \"<string>\",\n \"usPerson\": \"<string>\",\n \"usTin\": \"<string>\"\n },\n \"profession\": {\n \"employment\": \"self-employed\",\n \"professionName\": \"<string>\",\n \"industry\": \"Q\"\n },\n \"riskRequirements\": {\n \"entity\": \"ITA\",\n \"pepSelfDeclared\": \"yes\",\n \"placeOfWork\": \"<string>\",\n \"product\": \"<string>\",\n \"sector\": \"<string>\",\n \"sourceOfIncome\": \"<string>\"\n },\n \"deviceMetaData\": {\n \"browserType\": \"<string>\",\n \"browserVersion\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"language\": \"<string>\",\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"model\": \"<string>\",\n \"osCompromised\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"region\": \"<string>\",\n \"sdkVersion\": \"<string>\",\n \"analyticsId\": \"<string>\"\n },\n \"previousDocumentData\": {\n \"BirthDate\": \"<date>\",\n \"FirstName\": \"<string>\",\n \"LastName\": \"<string>\",\n \"Nationality\": \"<string>\",\n \"PlaceOfBirth\": \"<string>\"\n }\n }\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/clients/:clientId/verifications (DocumentAuthentication)",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"clients",
":clientId",
"verifications (DocumentAuthentication)"
],
"variable":[
{
"key":"clientId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"422",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/json"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"raw",
"raw":"{\n \"providerProcessId\": \"<string>\",\n \"processType\": \"ClientDocumentRenewal\",\n \"branch\": \"<string>\",\n \"clientData\": {\n \"person\": {\n \"type\": \"Natural Person\",\n \"name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"Female\",\n \"birthDate\": \"<date>\",\n \"placeOfBirth\": \"<string>\",\n \"initials\": \"<string>\",\n \"middleName\": \"<string>\",\n \"countryOfBirth\": \"<string>\"\n },\n \"address\": {\n \"street\": \"<string>\",\n \"streetNumber\": \"<integer>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"streetNumberPrefix\": \"<string>\",\n \"streetNumberSuffix\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"emailAndPhone\": {\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"tax\": {\n \"countrySubjectToTaxation\": \"<string>\",\n \"tin\": \"<string>\",\n \"usPerson\": \"<string>\",\n \"usTin\": \"<string>\"\n },\n \"profession\": {\n \"employment\": \"self-employed\",\n \"professionName\": \"<string>\",\n \"industry\": \"Q\"\n },\n \"riskRequirements\": {\n \"entity\": \"ITA\",\n \"pepSelfDeclared\": \"yes\",\n \"placeOfWork\": \"<string>\",\n \"product\": \"<string>\",\n \"sector\": \"<string>\",\n \"sourceOfIncome\": \"<string>\"\n },\n \"deviceMetaData\": {\n \"browserType\": \"<string>\",\n \"browserVersion\": \"<string>\",\n \"ipAddress\": \"<string>\",\n \"language\": \"<string>\",\n \"latitude\": \"<string>\",\n \"longitude\": \"<string>\",\n \"model\": \"<string>\",\n \"osCompromised\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"region\": \"<string>\",\n \"sdkVersion\": \"<string>\",\n \"analyticsId\": \"<string>\"\n },\n \"previousDocumentData\": {\n \"BirthDate\": \"<date>\",\n \"FirstName\": \"<string>\",\n \"LastName\": \"<string>\",\n \"Nationality\": \"<string>\",\n \"PlaceOfBirth\": \"<string>\"\n }\n }\n}",
"options":{
"raw":{
"headerFamily":"json",
"language":"json"
}
}
},
"url":{
"raw":"{{baseUrl}}/v1/clients/:clientId/verifications (DocumentAuthentication)",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"clients",
":clientId",
"verifications (DocumentAuthentication)"
],
"variable":[
{
"key":"clientId"
}
]
}
},
"status":"Unprocessable Entity (WebDAV) (RFC 4918)",
"code":422,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
}
]
},
{
"name":"Upload new identity document",
"request":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"DocumentType",
"value":"ResidencePermit",
"description":"(Required) The new identity document data."
},
{
"key":"DocumentNumber",
"value":"<string>",
"description":"(Required) The new identity document data."
},
{
"key":"IsPrimaryDocument",
"value":"false",
"description":"(Required) The new identity document data."
},
{
"key":"IssueDate",
"value":"<date>",
"description":"(Required) The new identity document data."
},
{
"key":"ExpirationDate",
"value":"<date>",
"description":"(Required) The new identity document data."
},
{
"key":"OriginTypeOs",
"value":"<string>",
"description":"(Required) The new identity document data."
},
{
"key":"KycFiles",
"value":"[object Object],[object Object]",
"description":"(Required) The new identity document data."
},
{
"key":"NfcDataGroups",
"value":"[object Object]",
"description":"(Required) The new identity document data."
},
{
"key":"Files",
"value":"<string>",
"description":"(Required) The file to upload. <br /> You can upload multiple files in one request."
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/document",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"document"
],
"variable":[
{
"key":"verificationId",
"value":"<string>",
"description":"(Required) Our unique identifier for the case, returned in the [Create Document Authentication](doc:create-document-authentication) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to upload the client’s new identity document for a Document Authentication case. <br /><br />**Guidance**: <br /><br />• Always specify the document type in the request, include at least 1 file and provide information about the file or it is ignored. <br />• Make separate request for each document type: selfie file, identity document file, EmbeddedFace file (portrait on the NFC chip). <br />• Requests can contain more than 1 file per document type. <br />• You can only upload an EmbeddedFace file **after** you have uploaded the identity document. The `documentNumber` in the EmbeddedFace file request must match the document. <br /><br /> **Updating document data** <br /><br />• After uploading a document, you can send new requests to update the document and its information. <br />• To add new files to a previously uploaded document, you must specify the **same** `documentType` and `documentNumber`, if relevant. Otherwise, it is considered a new document. <br />• To update the file content or data, you must specify the same `fileName` (case sensitive). Otherwise, it is added as a new file. <br />• Provide 1 unique filename per client. <br />• PDF documents **aren’t** updated."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"DocumentType",
"value":"ResidencePermit",
"description":"(Required) The new identity document data."
},
{
"key":"DocumentNumber",
"value":"<string>",
"description":"(Required) The new identity document data."
},
{
"key":"IsPrimaryDocument",
"value":"false",
"description":"(Required) The new identity document data."
},
{
"key":"IssueDate",
"value":"<date>",
"description":"(Required) The new identity document data."
},
{
"key":"ExpirationDate",
"value":"<date>",
"description":"(Required) The new identity document data."
},
{
"key":"OriginTypeOs",
"value":"<string>",
"description":"(Required) The new identity document data."
},
{
"key":"KycFiles",
"value":"[object Object],[object Object]",
"description":"(Required) The new identity document data."
},
{
"key":"NfcDataGroups",
"value":"[object Object]",
"description":"(Required) The new identity document data."
},
{
"key":"Files",
"value":"<string>",
"description":"(Required) The file to upload. <br /> You can upload multiple files in one request."
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/document",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"document"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"DocumentType",
"value":"ResidencePermit",
"description":"(Required) The new identity document data."
},
{
"key":"DocumentNumber",
"value":"<string>",
"description":"(Required) The new identity document data."
},
{
"key":"IsPrimaryDocument",
"value":"false",
"description":"(Required) The new identity document data."
},
{
"key":"IssueDate",
"value":"<date>",
"description":"(Required) The new identity document data."
},
{
"key":"ExpirationDate",
"value":"<date>",
"description":"(Required) The new identity document data."
},
{
"key":"OriginTypeOs",
"value":"<string>",
"description":"(Required) The new identity document data."
},
{
"key":"KycFiles",
"value":"[object Object],[object Object]",
"description":"(Required) The new identity document data."
},
{
"key":"NfcDataGroups",
"value":"[object Object]",
"description":"(Required) The new identity document data."
},
{
"key":"Files",
"value":"<string>",
"description":"(Required) The file to upload. <br /> You can upload multiple files in one request."
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/document",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"document"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\",\n \"errors\": [\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n}"
},
{
"name":"422",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Content-Type",
"value":"application/x-www-form-urlencoded"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"body":{
"mode":"urlencoded",
"urlencoded":[
{
"key":"DocumentType",
"value":"ResidencePermit",
"description":"(Required) The new identity document data."
},
{
"key":"DocumentNumber",
"value":"<string>",
"description":"(Required) The new identity document data."
},
{
"key":"IsPrimaryDocument",
"value":"false",
"description":"(Required) The new identity document data."
},
{
"key":"IssueDate",
"value":"<date>",
"description":"(Required) The new identity document data."
},
{
"key":"ExpirationDate",
"value":"<date>",
"description":"(Required) The new identity document data."
},
{
"key":"OriginTypeOs",
"value":"<string>",
"description":"(Required) The new identity document data."
},
{
"key":"KycFiles",
"value":"[object Object],[object Object]",
"description":"(Required) The new identity document data."
},
{
"key":"NfcDataGroups",
"value":"[object Object]",
"description":"(Required) The new identity document data."
},
{
"key":"Files",
"value":"<string>",
"description":"(Required) The file to upload. <br /> You can upload multiple files in one request."
}
]
},
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/document",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"document"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"Unprocessable Entity (WebDAV) (RFC 4918)",
"code":422,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\"\n}"
}
]
},
{
"name":"Process Document Authentication",
"request":{
"method":"POST",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/start",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"start"
],
"variable":[
{
"key":"verificationId",
"value":"<string>",
"description":"(Required) Our unique identifier for the case, returned in the [Create Document Authentication](doc:create-document-authentication) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to trigger processing of a Document Authentication case."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/start",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"start"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"400",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/start",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"start"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"Bad Request",
"code":400,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\",\n \"errors\": [\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"code\": \"<integer>\",\n \"property\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n}"
},
{
"name":"404",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/start",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"start"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"Not Found",
"code":404,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
},
{
"name":"422",
"originalRequest":{
"method":"POST",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:verificationId/start",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":verificationId",
"start"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"Unprocessable Entity (WebDAV) (RFC 4918)",
"code":422,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"message\": \"<string>\",\n \"code\": \"<integer>\"\n}"
}
]
},
{
"name":"Get Document Authentication status",
"request":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
}
],
"url":{
"raw":"{{baseUrl}}/v2/data/:verificationId/result",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"data",
":verificationId",
"result"
],
"variable":[
{
"key":"verificationId",
"value":"<string>",
"description":"(Required) Our unique identifier for the case, returned in the [Create Document Authentication](doc:create-document-authentication) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to get the [status](https://docs.fourthline.com/docs/docauth-statuses) of a Document Authentication case. <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: To receive status updates automatically, set up a [webhook](https://docs.fourthline.com/docs/webhooks)."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"key":"Accept",
"value":"application/json"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v2/data/:verificationId/result",
"host":[
"{{baseUrl}}"
],
"path":[
"v2",
"data",
":verificationId",
"result"
],
"variable":[
{
"key":"verificationId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"json",
"header":[
{
"key":"Content-Type",
"value":"application/json"
}
],
"cookie":[
],
"body":"{\n \"hash\": \"<string>\",\n \"dataValidationError\": {},\n \"verificationId\": \"<string>\",\n \"verificationStatus\": \"<string>\"\n}"
}
]
},
{
"name":"Get CDD PDF",
"request":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"text/plain"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:workflowId/getpdfresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":workflowId",
"getpdfresult"
],
"variable":[
{
"key":"workflowId",
"value":"<string>",
"description":"(Required) Our unique identifier for the workflow, returned in the [Create workflow](doc:create-workflow) response. <br />Format: uuid string <br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0` <br /><br /><img src=\"https://files.readme.io/8eb9022-Inline_Tip.svg\" align=\"left\"/> **Tip**: Use this as the case reference number for any questions."
}
]
},
"description":"Use this endpoint to download the [CDD Report](https://docs.fourthline.com/docs/reports) in PDF format."
},
"response":[
{
"name":"200",
"originalRequest":{
"method":"GET",
"header":[
{
"description":"To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to `no-cache`.",
"key":"Cache-Control",
"value":"<string>"
},
{
"key":"Accept",
"value":"text/plain"
},
{
"description":"Added as a part of security scheme: oauth2",
"key":"Authorization",
"value":"<token>"
}
],
"url":{
"raw":"{{baseUrl}}/v1/verifications/:workflowId/getpdfresult",
"host":[
"{{baseUrl}}"
],
"path":[
"v1",
"verifications",
":workflowId",
"getpdfresult"
],
"variable":[
{
"key":"workflowId"
}
]
}
},
"status":"OK",
"code":200,
"_postman_previewlanguage":"text",
"header":[
{
"key":"Content-Type",
"value":"text/plain"
}
],
"cookie":[
],
"body":"{}"
}
]
}
],
"auth":{
"type":"oauth2"
},
"variable":[
{
"key":"baseUrl",
"value":"https://api.ext-sandbox.fourthline.com"
}
]
}Updated 16 days ago