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

Retrieve info on identifications for a request eID

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) Advanced scenarios are coming.

Simplest Scenario

Endpoint

  • URL: /request/{id}/identification
  • 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 unique identifier of the request for which you want to retrieve the identification. This should be included in the URL path. Example: 123e4567-e89b-12d3-a456-426614174000

Example cURL API call

curl -X GET "https://test-eu-ie1-api.namirialonboarding.com/api/v2/request/YOUR_REQUEST_ID/identification" \
-H "Accept: application/json" \
-H "X-Api-Key: YOUR_API_KEY"

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

Responses

  • 200 OK

    • Description: The details of the requested identification.
    • Example Response:
// eID RESPONSE EXAMPLE
{
    "organizationId": "12373a34-8dcb-4e60-990e-80a56fb5b69a",
    "personData": {
        "lastName": "John",
        "firstName": "Doe",
        "birthDate": "1980-01-01",
        "personalNumber": "DOEJHN90A01D488L",
        "gender": "M",
        "documentDetails": {
            "issuanceCountry": "IT",
            "issuanceAuthority": "",
            "type": "Undefined"
        }
    },
    "validationDetail": {
 "personalNumber": {
            "requestMatched": "SKIPPED",
            "otpValidated": "SKIPPED",
            "byIdentificationSource": "OK",
            "byRequestInput": "SKIPPED"
        },
        "lastName": {
            "requestMatched": "SKIPPED",
            "otpValidated": "SKIPPED",
            "byIdentificationSource": "OK",
            "byRequestInput": "SKIPPED"
        },
        "firstName": {
            "requestMatched": "SKIPPED",
            "otpValidated": "SKIPPED",
            "byIdentificationSource": "OK",
            "byRequestInput": "SKIPPED"
        },
        "birthDate": {
            "requestMatched": "SKIPPED",
            "otpValidated": "SKIPPED",
            "byIdentificationSource": "OK",
            "byRequestInput": "SKIPPED"
        },
        "gender": {
            "requestMatched": "SKIPPED",
            "otpValidated": "SKIPPED",
            "byIdentificationSource": "OK",
            "byRequestInput": "SKIPPED"
        },
        "phoneNumber": {
            "requestMatched": "SKIPPED",
            "otpValidated": "SKIPPED",
            "byIdentificationSource": "SKIPPED",
            "byRequestInput": "SKIPPED"
        },
        "email": {
            "requestMatched": "SKIPPED",
            "otpValidated": "SKIPPED",
            "byIdentificationSource": "SKIPPED",
            "byRequestInput": "SKIPPED"
        },
        "documentNumber": {
            "requestMatched": "SKIPPED",
            "otpValidated": "SKIPPED",
            "byIdentificationSource": "SKIPPED",
            "byRequestInput": "SKIPPED"
        }
    },
    "spid": {
        "samlAssertion": {
            "id": "a6293344-edd2-49cf-8d7a-f65c16eeef0a",
            "filename": "evidence_document.xml",
            "mimeType": "application/xml",
            "name": "Evidence Document",
            "type": "IDP_ASSERTION",
            "family": "IDENTIFICATION_ASSET",
            "metadata": {
                "source": "idhub",
                "source-subtype": "spid"
            },
            "resourceUrl": "https://test-onboarding.namirial.app/api/v2/storage/data/evidence_document.xml?t=WXYKAACff6xLmJZLsWpAbpcKR_6ZTC5QlCu0iXHyaGwrWlocnBdsp2kFJT_POjR_9xOkj1W18amx1Ui8uGrEs5qnCbJgntlvb4hdYqqUNZpQwszSxouMleCsaD2tPEk50WHKVdwhLi1HRGGhkMHA6ulXyXqFixzfBijpHjCcDb3J55Lly3ILZL-CNUhTGuY-z0kiLxv5DB95nUNoBLNhZLXFDw",
            "urlValidBefore": "2025-09-04T21:25:08.577840922Z",
            "status": "AVAILABLE",
            "resourceVersionId": "XXXXXXXXXXX",
            "sizeBytes": 1111
        },
        "spidCode": "NAMI0000006825",
        "fiscalNumber": "DOEJHN90A01D488L",
        "name": "John",
        "familyName": "Doe",
        "placeOfBirth": "D488",
        "dateOfBirth": "1990-01-01",
        "gender": "M",
        "countryOfBirth": "",
        "address": "",
        "digitalAddress": ""
    },
    "id": "12309026-fe80-49d6-aabf-faa6434d2165",
    "actor": "userToIdentify",
    "stepId": "identification",
    "status": "COMPLETED",
    "source": "SPID",
    "finalizedAt": "2025-09-03T17:04:06.167190928Z"
}

  • 404 Not Found

    • Description: The requested resource was not found.
    • Example Response:
{
  "type": "about:blank",
  "status": 404,
  "title": "Not Found",
  "detail": "The requested resource was not found.",
  "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000?ts=1729667463",
  "retryable": false
}
Previous page
Next page