Skip to content
DEVELOPER DOCUMENTATION
/
/
/
Retrieve info on Data Enr...
Last updated

Retrieve info on Data Enrichment

The Data Enrichment step allows you to insert one or more configurable pages into the onboarding journey, where users can provide additional structured data and/or upload attachments. When enabled in the Request Type model, an extra step appears during identification to collect this information.

Therefore, it is possible to retrieve the information provided starting from a request and then accessing data.

This API call allows you to retrieve the data collected on a specific request.

‌

Endpoint

  • URL: /request/{id}/dataEnrichments/simple
  • 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

Example cURL API call

curl --location 'https://test-eu-ie1-api.namirialonboarding.com/api/v2/request/{id}/dataEnrichments/simple' \
--header 'Accept: application/json' \
--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.

Responses

  • 200 OK

    • Example Response:

      {
    "fields": [
        {
            "id": "PHONE_OTP-1",
            "labelDisplayId": "labelDisplayIdPhone",
            "templateId": "123a3a02-1234-1234-9f4d-4e9d3f4a6fed",
            "value": {
                "type": "PHONE_OTP"
            },
            "status": "VALIDATED"
        },
        {
            "id": "EMAIL_OTP-1",
            "labelDisplayId": "labelDisplayIdEmail",
            "templateId": "123a3a02-1234-1234-9f4d-4e9d3f4a6fed",
            "value": {
                "type": "EMAIL_OTP"
            },
            "status": "VALIDATED"
        }
    ]
}
Previous page
Next page