Content Comparison

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

This API supports common integrations scenarios:

Simplest scenario
1. 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)
Simple scenario with multiple actors
1. Similarly to previous case, the integrator is interested in retrieving only the latest identification outcome (or the request type supports just one identification process)
Advanced scenario
1. The integrator is interested in retrieving the outcome of all idetifications attempts and thie is supported by the request type. This applies both for types with one actor or multiple actors.

1. 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 you want to retrieve the identification for. This should be included in the URL path. Example: 123e4567-e89b-12d3-a456-426614174000

Example cURL API call

Code Block

language	json

curl -X GET "https://test.onboarding.namirial.app/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:

Code Block

language	json

{
  "id": "123e4567-e89b-12d3-a456-426614174001",
  "actor": "customer",
  "status": "COMPLETED",
  "source": "FACEMATCH",
  "personData": {
    "firstName": "John",
    "lastName": "Doe",
    "birthDate": "1980-01-01",
    "gender": "M",
    "nationality": "IT",
    "phoneNumber": "+393331112233",
    "email": "john.doe@example.com",
    "address": "Via del Mondo 9, Firenze, IT"
  },
  "validationDetail": {
    "personalNumber": "OK",
    "lastName": "OK",
    "firstName": "OK",
    "birthDate": "OK",
    "gender": "OK",
    "phoneNumber": "OK",
    "email": "OK",
    "documentNumber": "OK"
  },
  "finalizedAt": "2024-10-29T17:42:16Z"
}

404 Not Found

Description: The requested resource was not found.

Example Response:

Code Block

language	json

{
  "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
}

2. Simple scenario with multiple actors

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 you want to retrieve the identification for. This should be included in the URL path. Example: 123e4567-e89b-12d3-a456-426614174000

Query parameters

actor (optional): The name of the actor. According to the endpoint, it may be required if multiple actors are defined for the request type. Example: customer

Example cURL API call

Code Block

language	json

curl -X GET "https://test.onboarding.namirial.app/api/v2/request/YOUR_REQUEST_ID/identification?actor=customer" \
-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:

Code Block

language	json

{
  "id": "123e4567-e89b-12d3-a456-426614174001",
  "actor": "customer",
  "status": "COMPLETED",
  "source": "FACEMATCH",
  "personData": {
    "firstName": "John",
    "lastName": "Doe",
    "birthDate": "1980-01-01",
    "gender": "M",
    "nationality": "IT",
    "phoneNumber": "+393331112233",
    "email": "john.doe@example.com",
    "address": "Via del Mondo 9, Firenze, IT"
  },
  "validationDetail": {
    "personalNumber": "OK",
    "lastName": "OK",
    "firstName": "OK",
    "birthDate": "OK",
    "gender": "OK",
    "phoneNumber": "OK",
    "email": "OK",
    "documentNumber": "OK"
  },
  "finalizedAt": "2024-10-29T17:42:16Z"
}

404 Not Found

Description: The requested resource was not found.

Example Response:

Code Block

language	json

{
  "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
}

3. Advanced scenario

This scenario requires retrieving information from the Get list of identifications for a request endpoint.

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 you want to retrieve the identification for. This should be included in the URL path. Example: 123e4567-e89b-12d3-a456-426614174000

Query parameters

identificationId (optional): The unique identifier of the identification. If not set, the endpoint returns the last identification. Example: 123e4567-e89b-12d3-a456-426614174001
actor (optional): The name of the actor. According to the endpoint, it may be required if multiple actors are defined for the request type. Example: customer

Example cURL API call

Code Block

language	json

curl -X GET "https://test.onboarding.namirial.app/api/v2/request/YOUR_REQUEST_ID/identification?identificationId=YOUR_IDENTIFICATION_ID&actor=customer" \
-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, and YOUR_IDENTIFICATION_ID with the ID of the identification.

Responses

200 OK

Description: The details of the requested identification.

Example Response:

Code Block

language	json

{
  "id": "123e4567-e89b-12d3-a456-426614174001",
  "actor": "customer",
  "status": "COMPLETED",
  "source": "FACEMATCH",
  "personData": {
    "firstName": "John",
    "lastName": "Doe",
    "birthDate": "1980-01-01",
    "gender": "M",
    "nationality": "IT",
    "phoneNumber": "+393331112233",
    "email": "john.doe@example.com",
    "address": "Via del Mondo 9, Firenze, IT"
  },
  "validationDetail": {
    "personalNumber": "OK",
    "lastName": "OK",
    "firstName": "OK",
    "birthDate": "OK",
    "gender": "OK",
    "phoneNumber": "OK",
    "email": "OK",
    "documentNumber": "OK"
  },
  "finalizedAt": "2024-10-29T17:42:16Z"
}

404 Not Found

Description: The requested resource was not found.

Example Response:

Code Block

language	json

{
  "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
}

Version	Old Version 1	New Version Current
Changes made by	Giovanni Di Prisco	Diego Foroni
Saved on	Oct 31, 2024	Oct 31, 2024

Content Comparison

Versions Compared

Key

1. Simplest scenario

Endpoint

Headers

Path parameters

Example cURL API call

Responses

2. Simple scenario with multiple actors

Endpoint

Headers

Path parameters

Query parameters

Example cURL API call

Responses

3. Advanced scenario

Endpoint

Headers

Path

parameters

Query parameters

Example cURL API call

Responses