Skip to end of banner
Go to start of banner

Get info on an identification for a request

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Next »

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

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

  • 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

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:

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

      {
  "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
}
  • No labels