Retrieve info on identifications for a request ID DOC
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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:

// ID DOC RESPONSE EXAMPLE

{
 "organizationId": "12373a34-8dcb-4e60-990e-80a56fb5b69a",
  "personData": {
    "firstName": "John",
    "lastName": "Doe",
    "birthDate": "1980-01-01",
    "birthPlace": "SENIGALLIA"
    "personalNumber": "DOEJHN90A01D488L",
    "gender": "M",
    "nationality": "IT",
    "address": {
            "address": "VIA PROVA 12"
        },  
        "documentDetails": {
            "issuanceCountry": "IT",
            "issuanceAuthority": "SENIGALLIA",
            "type": "IdentityCard",
            "number": "CAXXXXXUK",
            "issuedOn": "2025-01-08",
            "expiryDate": "2034-12-29",
            "mrz": [
                "C<ITACAXXXXXK0<<<<<<<<<<<<<<<",
                "XXXXXXM341229XITA<<<<<<<<<<<6",
                "DOE<<JOHN<<<<<<<<<<<<<<<<<<<<<"
            ]
        }
    },
    "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": "OK",
            "byRequestInput": "SKIPPED"
        }
    },
    "operator": {
        "internalOperator": {
            "reviewPersonData": {
                "firstName": {
                    "value": "JOHN",
                    "status": "NOT_REVIEWED",
                    "operatorConfiguration": {
                        "mode": "DISABLED",
                        "revisable": false
                    }
                },
                "lastName": {
                    "value": "DOE",
                    "status": "NOT_REVIEWED",
                    "operatorConfiguration": {
                        "mode": "DISABLED",
                        "revisable": false
                    }
                },
                "birthDate": {
                    "value": "1971-12-29",
                    "status": "NOT_REVIEWED",
                    "operatorConfiguration": {
                        "mode": "DISABLED",
                        "revisable": false
                    }
                },
                "birthPlace": {
                    "value": "SENIGALLIA",
                    "status": "NOT_REVIEWED",
                    "operatorConfiguration": {
                        "mode": "DISABLED",
                        "revisable": false
                    }
                },
                "personalNumber": {
                    "value": "DOEJHN90A01D488L",
                    "status": "NOT_REVIEWED",
                    "operatorConfiguration": {
                        "mode": "DISABLED",
                        "revisable": false
                    }
                },
                "gender": {
                    "value": "M",
                    "status": "NOT_REVIEWED",
                    "operatorConfiguration": {
                        "mode": "DISABLED",
                        "revisable": false
                    }
                },
                "nationality": {
                    "value": "IT",
                    "status": "NOT_REVIEWED",
                    "operatorConfiguration": {
                        "mode": "DISABLED",
                        "revisable": false
                    }
                },
                "phoneNumber": {
                    "status": "NOT_REVIEWED",
                    "operatorConfiguration": {
                        "mode": "DISABLED",
                        "revisable": false
                    }
                },
                "address": {
                    "value": {
                        "address": "VIA PROVA 12"
                    },
                    "status": "NOT_REVIEWED",
                    "operatorConfiguration": {
                        "mode": "DISABLED",
                        "revisable": false
                    }
                },
                "email": {
                    "status": "NOT_REVIEWED",
                    "operatorConfiguration": {
                        "mode": "DISABLED",
                        "revisable": false
                    }
                },
                "reviewDocumentDetails": {
                    "issuanceCountry": {
                        "value": "IT",
                        "status": "NOT_REVIEWED",
                        "operatorConfiguration": {
                            "mode": "DISABLED",
                            "revisable": false
                        }
                    },
                    "issuanceAuthority": {
                        "value": "SENIGALLIA",
                        "status": "NOT_REVIEWED",
                        "operatorConfiguration": {
                            "mode": "DISABLED",
                            "revisable": false
                        }
                    },
                    "type": {
                        "value": "IdentityCard",
                        "status": "NOT_REVIEWED",
                        "operatorConfiguration": {
                            "mode": "DISABLED",
                            "revisable": false
                        }
                    },
                    "number": {
                        "value": "CAXXXXXUK",
                        "status": "NOT_REVIEWED",
                        "operatorConfiguration": {
                            "mode": "DISABLED",
                            "revisable": false
                        }
                    },
                    "issuedOn": {
                        "value": "2025-01-08",
                        "status": "NOT_REVIEWED",
                        "operatorConfiguration": {
                            "mode": "DISABLED",
                            "revisable": false
                        }
                    },
                    "expiryDate": {
                        "value": "2034-12-29",
                        "status": "NOT_REVIEWED",
                        "operatorConfiguration": {
                            "mode": "DISABLED",
                            "revisable": false
                        }
                    }
                }
            }
        }
    },
    "idSelf": {
        "receivedAt": "2025-09-03T08:07:59.121147312Z",
        "artifacts": {
            "biometry": [],
            "document": [
                {
                    "id": "965XXXX-XXXX-XXXX-XXXX-XXXX9695a1bb",
                    "filename": "8867XXXX-XXXX-XXXX-XXXX-XXXX133e4811_VIDEO_FRAME_0_1700_XNuiQFcQKo.jpeg",
                    "mimeType": "image/jpeg",
                    "type": "IDENTITY_DOCUMENT",
                    "family": "IDENTIFICATION_ASSET",
                    "subType": "FRONT_SIDE",
                    "resourceUrl": "https://test-eu-ie1-api.namirialonboarding.com/api/v2/storage/data/8867XXXX-XXXX-XXXX-XXXX-XXXX133e4811_VIDEO_FRAME_0_1700_XNuiQFcQKo.jpeg?t=...
                    "urlValidBefore": "2025-09-05T16:17:09.863588136Z",
                    "status": "AVAILABLE",
                    "resourceVersionId": "XXXXXXXXXXXXXXXXX",
                    "sizeBytes": 1111111
                },
                {
                    "id": "948bXXXX-XXXX-XXXX-XXXX-XXXXddd2500a",
                    "filename": "8867XXXX-XXXX-XXXX-XXXX-XXXX133e4811_VIDEO_FRAME_0_12333_aom8OqrzAN.jpeg",
                    "mimeType": "image/jpeg",
                    "type": "IDENTITY_DOCUMENT",
                    "family": "IDENTIFICATION_ASSET",
                    "subType": "BACK_SIDE",
                    "resourceUrl": "https://test-eu-ie1-api.namirialonboarding.com/api/v2/storage/data/8867XXXX-XXXX-XXXX-XXXX-XXXX133e4811_VIDEO_FRAME_0_12333_aom8OqrzAN.jpeg?t=...
                    "urlValidBefore": "2025-09-05T16:17:09.864321792Z",
                    "status": "AVAILABLE",
                    "resourceVersionId": "XXXXXXXXXXXXXXXXX",
                    "sizeBytes": 1111111
                },
                {
                    "id": "5453XXXX-XXXX-XXXX-XXXX-XXXX9390b26c",
                    "filename": "8867XXXX-XXXX-XXXX-XXXX-XXXX133e4811_ID_PHOTO_0_1700_hnYLKYuBOK.jpeg",
                    "mimeType": "image/jpeg",
                    "type": "IDENTITY_DOCUMENT",
                    "family": "IDENTIFICATION_ASSET",
                    "subType": "ID_PHOTO",
                    "resourceUrl": "https://test-eu-ie1-api.namirialonboarding.com/api/v2/storage/data/8867XXXX-XXXX-XXXX-XXXX-XXXX133e4811_ID_PHOTO_0_1700_hnYLKYuBOK.jpeg?t=alL3s...
                    "urlValidBefore": "2025-09-05T16:17:09.864383831Z",
                    "status": "AVAILABLE",
                    "resourceVersionId": "XXXXXXXXXXXXXXXXX",
                    "sizeBytes": 1111111
                },
                {
                    "id": "3d76XXXX-XXXX-XXXX-XXXX-XXXX0bd54ad6",
                    "filename": "8867XXXX-XXXX-XXXX-XXXX-XXXX133e4811_PROCESSED_IMAGE_0_12333_RtAB39TzS2.jpeg",
                    "mimeType": "image/jpeg",
                    "type": "IDENTITY_DOCUMENT",
                    "family": "IDENTIFICATION_ASSET",
                    "subType": "PROCESSED_BACK_SIDE",
                    "resourceUrl": "https://test-eu-ie1-api.namirialonboarding.com/api/v2/storage/data/8867XXXX-XXXX-XXXX-XXXX-XXXX133e4811_PROCESSED_IMAGE_0_12333_RtAB39TzS2.jpeg?t=...
                    "urlValidBefore": "2025-09-05T16:17:09.864442641Z",
                    "status": "AVAILABLE",
                    "resourceVersionId": "XXXXXXXXXXXXXXXXX",
                    "sizeBytes": 1111111
                },
                {
                    "id": "2af6XXXX-XXXX-XXXX-XXXX-XXXX97b8513c",
                    "filename": "8867XXXX-XXXX-XXXX-XXXX-XXXX133e4811_PROCESSED_IMAGE_0_1700_egVIiym7Hl.jpeg",
                    "mimeType": "image/jpeg",
                    "type": "IDENTITY_DOCUMENT",
                    "family": "IDENTIFICATION_ASSET",
                    "subType": "PROCESSED_FRONT_SIDE",
                    "resourceUrl": "https://test-eu-ie1-api.namirialonboarding.com/api/v2/storage/data/8867XXXX-XXXX-XXXX-XXXX-XXXX133e4811_PROCESSED_IMAGE_0_1700_egVIiym7Hl.jpeg?t=uQ...
                    "urlValidBefore": "2025-09-05T16:17:09.864497676Z",
                    "status": "AVAILABLE",
                    "resourceVersionId": "XXXXXXXXXXXXXXXXX",
                    "sizeBytes": 1111111
                }
            ]
        },
        "documentCheck": {
            "documentType": "ID_CARD",
            "documentTypeFamily": "IDENTITY_DOCUMENT",
            "controlsSummary": 0,
            "keysWithError": []
        }
    },
    "id": "4ab4XXXX-XXXX-XXXX-XXXX-XXXX980f7fd1",
    "actor": "userToIdentify",
    "stepId": "identification",
    "status": "COMPLETED",
    "source": "ID-SELF",
    "finalizedAt": "2025-09-03T08:08:02.182031791Z"
}

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
}

Retrieve info on identifications for a request ID DOCCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude