Retrieve info on identifications for a request IDSelf
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 SELF 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",
    "phoneNumber": "+393331112233",
    "email": "john.doe@example.com"
    "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": {
                    "value": "+393331112233",
                    "status": "NOT_REVIEWED",
                    "operatorConfiguration": {
                        "mode": "DISABLED",
                        "revisable": false
                    }
                },
                "address": {
                    "value": {
                        "address": "VIA PROVA 12"
                    },
                    "status": "NOT_REVIEWED",
                    "operatorConfiguration": {
                        "mode": "DISABLED",
                        "revisable": false
                    }
                },
                "email": {
                    "value": "john.doe@example.com",
                    "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": {
        "id": "d883XXXX-XXXX-XXXX-XXXX-XXXXaa859664",
        "receivedAt": "2025-09-03T12:05:38.531497079Z",
        "artifacts": {
            "biometry": [
                {
                    "id": "ddd5XXXX-XXXX-XXXX-XXXX-XXXXe7708fb1",
                    "filename": "4994XXXX-XXXX-XXXX-XXXX-XXXX8b870cd0.webm",
                    "mimeType": "video/webm",
                    "type": "BIOMETRY_VIDEO",
                    "family": "IDENTIFICATION_ASSET",
                    "resourceUrl": "https://test-eu-ie1-api.namirialonboarding.com/api/v2/storage/data/4994XXXX-XXXX-XXXX-XXXX-XXXX8b870cd0.webm?t=A1gz9EWnscq1j0-Koezpnwas5......",
                    "urlValidBefore": "2025-09-04T21:30:54.599644612Z",
                    "status": "AVAILABLE",
                    "resourceVersionId": "XXXXXXXXXXXXXXXXX",
                    "sizeBytes": 1111111
                },
                {
                    "id": "53dXXXX-XXXX-XXXX-XXXX-XXXX796d22ac",
                    "filename": "7596XXXX-XXXX-XXXX-XXXX-XXXXd81a727d_FACE_0_342_6lcDc8oIRn.jpeg",
                    "mimeType": "image/jpeg",
                    "type": "BIOMETRY_IMAGE",
                    "family": "IDENTIFICATION_ASSET",
                    "subType": "BEST_SELFIE",
                    "resourceUrl": "https://test-eu-ie1-api.namirialonboarding.com/api/v2/storage/data/759XXXX5-XXXX-XXXX-XXXX-XXXXd81a727d_FACE_0_342_6lcDc8oIRn.jpeg?t=Tjm....
                    "urlValidBefore": "2025-09-04T21:30:54.600173641Z",
                    "status": "AVAILABLE",
                    "resourceVersionId": "XXXXXXXXXXXXXXXXX",
                    "sizeBytes": 1111111
                },
                {
                    "id": "e957XXXX-XXXX-XXXX-XXXX-XXXXe411f14b",
                    "filename": "7596XXXX-XXXX-XXXX-XXXX-XXXXd81a727d_VIDEO_FRAME_0_342_IRxkPr30J3.jpeg",
                    "mimeType": "image/jpeg",
                    "type": "BIOMETRY_IMAGE",
                    "family": "IDENTIFICATION_ASSET",
                    "subType": "SELFIE",
                    "resourceUrl": "https://test-eu-ie1-api.namirialonboarding.com/api/v2/storage/data/7596XXXX-XXXX-XXXX-XXXX-XXXXd81a727d_VIDEO_FRAME_0_342_IRxkPr30J3.jpeg?....
                    "urlValidBefore": "2025-09-04T21:30:54.600246955Z",
                    "status": "AVAILABLE",
                    "resourceVersionId": "XXXXXXXXXXXXXXXXX",
                    "sizeBytes": 1111111
                },
                {
                    "id": "2fcbXXXX-XXXX-XXXX-XXXX-XXXXa1b7c88fa",
                    "filename": "7596XXXX-XXXX-XXXX-XXXX-XXXXd81a727d_VIDEO_FRAME_0_665_WUd7cVpI2M.jpeg",
                    "mimeType": "image/jpeg",
                    "type": "BIOMETRY_IMAGE",
                    "family": "IDENTIFICATION_ASSET",
                    "subType": "SELFIE",
                    "resourceUrl": "https://test-eu-ie1-api.namirialonboarding.com/api/v2/storage/data/7596XXXX-XXXX-XXXX-XXXX-XXXXd81a727d_VIDEO_FRAME_0_665_WUd7cVpI2M.jpeg?t=9....
                    "urlValidBefore": "2025-09-04T21:30:54.600313310Z",
                    "status": "AVAILABLE",
                    "resourceVersionId": "XXXXXXXXXXXXXXXXX",
                    "sizeBytes": 1111111
                },
                {
                    "id": "8b1bXXXX-XXXX-XXXX-XXXX-XXXX2ad92c86",
                    "filename": "7596XXXX-XXXX-XXXX-XXXX-XXXXd81a727d_VIDEO_FRAME_0_2049_8IjHJJKGQw.jpeg",
                    "mimeType": "image/jpeg",
                    "type": "BIOMETRY_IMAGE",
                    "family": "IDENTIFICATION_ASSET",
                    "subType": "SELFIE",
                    "resourceUrl": "https://test-eu-ie1-api.namirialonboarding.com/api/v2/storage/data/7596XXXX-XXXX-XXXX-XXXX-XXXXd81a727d_VIDEO_FRAME_0_2049_8IjHJJKGQw.jpeg?t=F....
                    "urlValidBefore": "2025-09-04T21:30:54.600372555Z",
                    "status": "AVAILABLE",
                    "resourceVersionId": "XXXXXXXXXXXXXXXXX",
                    "sizeBytes": 1111111
                }
            ],
            "document": [
                {
                    "id": "35d6XXXX-XXXX-XXXX-XXXX-XXXX46d5a302",
                    "filename": "16beXXXX-XXXX-XXXX-XXXX-XXXX37577392.webm",
                    "mimeType": "video/webm",
                    "type": "DOCUMENT_VIDEO",
                    "family": "IDENTIFICATION_ASSET",
                    "resourceUrl": "https://test-eu-ie1-api.namirialonboarding.com/api/v2/storage/data/16beXXXX-XXXX-XXXX-XXXX-XXXX37577392.webm?t=FyYd--MHamzBqnVsHWHu58VaB8bP-zBf...
                    "urlValidBefore": "2025-09-04T21:30:54.600442816Z",
                    "status": "AVAILABLE",
                    "resourceVersionId": "XXXXXXXXXXXXXXXXX",
                    "sizeBytes": 1111111
                },
                {
                    "id": "7889XXXX-XXXX-XXXX-XXXX-XXXX70f9b33d",
                    "filename": "1ec2XXXX-XXXX-XXXX-XXXX-XXXX4892514a_VIDEO_FRAME_0_1068_Fh3jhUjr2c.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/1ec2XXXX-XXXX-XXXX-XXXX-XXXX4892514a_VIDEO_FRAME_0_1068_Fh3jhUjr2c.jpeg?t=8p_....
                    "urlValidBefore": "2025-09-04T21:30:54.600508905Z",
                    "status": "AVAILABLE",
                    "resourceVersionId": "XXXXXXXXXXXXXXXXX",
                    "sizeBytes": 1111111
                },
                {
                    "id": "927XXXX-XXXX-XXXX-XXXX-XXXXcd6499a0",
                    "filename": "1ec2XXXX-XXXX-XXXX-XXXX-XXXX4892514a_VIDEO_FRAME_0_9695_wPiD7KhAfx.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/1ec2XXXX-XXXX-XXXX-XXXX-XXXX4892514a_VIDEO_FRAME_0_9695_wPiD7KhAfx.jpeg?t=8f_pI....
                    "urlValidBefore": "2025-09-04T21:30:54.600567561Z",
                    "status": "AVAILABLE",
                    "resourceVersionId": "XXXXXXXXXXXXXXXXX",
                    "sizeBytes": 1111111
                },
                {
                    "id": "2b61XXXX-XXXX-XXXX-XXXX-XXXXb1220cac",
                    "filename": "1ec2XXXX-XXXX-XXXX-XXXX-XXXX4892514a_ID_PHOTO_0_1068_T6tiDWrpmP.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/1ecXXXX-XXXX-XXXX-XXXX-XXXX4892514a_ID_PHOTO_0_1068_T6tiDWrpmP.jpeg?t=yrn8ZtPvf....
                    "urlValidBefore": "2025-09-04T21:30:54.600778719Z",
                    "status": "AVAILABLE",
                    "resourceVersionId": "XXXXXXXXXXXXXXXXX",
                    "sizeBytes": 1111111
                },
                {
                    "id": "8362XXXX-XXXX-XXXX-XXXX-XXXX4b02f739",
                    "filename": "1ec2XXXX-XXXX-XXXX-XXXX-XXXX4892514a_PROCESSED_IMAGE_0_9695_kx4ejL7dqj.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/1ec2XXXX-XXXX-XXXX-XXXX-XXXX4892514a_PROCESSED_IMAGE_0_9695_kx4ejL7dqj.jpeg?t=LvO....
                    "urlValidBefore": "2025-09-04T21:30:54.600945362Z",
                    "status": "AVAILABLE",
                    "resourceVersionId": "XXXXXXXXXXXXXXXXX",
                    "sizeBytes": 1111111
                },
                {
                    "id": "132dXXXX-XXXX-XXXX-XXXX-XXXX0b135a8b",
                    "filename": "1ec2XXXX-XXXX-XXXX-XXXX-XXXX4892514a_PROCESSED_IMAGE_0_1068_zQTyTgjcTR.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/1ec2XXXX-XXXX-XXXX-XXXX-XXXX4892514a_PROCESSED_IMAGE_0_1068_zQTyTgjcTR.jpeg?t=b4Tl....
                    "urlValidBefore": "2025-09-04T21:30:54.601094523Z",
                    "status": "AVAILABLE",
                    "resourceVersionId": "XXXXXXXXXXXXXXXXX",
                    "sizeBytes": 1111111
                }
            ]
        },
        "biometryCheck": {
            "controlsSummary": 0,
            "keysWithError": []
        },
        "documentCheck": {
            "documentType": "ID_CARD",
            "documentTypeFamily": "IDENTITY_DOCUMENT",
            "controlsSummary": 0,
            "keysWithError": []
        }
    },
    "id": "0797XXXX-XXXX-XXXX-XXXX-XXXX15bdecd4",
    "actor": "userToIdentify",
    "stepId": "identification",
    "status": "COMPLETED",
    "source": "ID-SELF",
    "finalizedAt": "2025-09-03T12:05:43.487344213Z"
}

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 IDSelfCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude