Skip to content
DEVELOPER DOCUMENTATION
/
/
/
Retrive info on Doc Proce...
Last updated

Retrieve info on DocProcessor

This API call allows you to retrieve the details of a specific identification by its unique identifier.

This API supports common integration scenarios:

Simplest scenario: In case the request type has just one actor and the integrator is interested in retrieving only the latest identification outcome (or the request type supports just one identification process) and handles only the Call Scenario in synchronous mode so as to immediately obtain the result with the information read from the document

Advanced scenarios with asynchronous controls are coming.

‌

Endpoint

  • URL: //request/{id}/documentChecks
  • Method: GET

Headers

Ensure you include the following headers in your request:

  • Accept: application/json
  • X-Api-Key: YOUR_API_KEY (replace YOUR_API_KEY with your actual API key)

Path parameters

  • id (required): The ID of the request for which you want to retrieve identifications. Example: 123e4567-e89b-12d3-a456-426614174000

Body parameters

  • urlValidBefore: Datetime the URL to retrieve the document images (max 5 days from the request). If you don’t set this parameter, you will not get any URL. Example: 2025-04-06T23:59:59.00000Z

Example cURL API call

curl --location 'https://test-eu-ie1-api.namirialonboarding.com/api/v2/request/YOUR_REQUEST_ID/documentChecks?includeUrlValidBefore=2025-12-19T20:11:06.966074Z' \
--header 'X-Api-Key: YOUR_API_KEY'

Replace YOUR_API_KEY with your actual API key and YOUR_REQUEST_ID with the ID of the request.

Previous page
Next page