Get list of identifications for a request

This API call allows you to retrieve a list of identifications associated with a specific request. The request can include various parameters to filter and sort the results according to your needs.

Endpoint

• URL: /request/{id}/identifications

• 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)

Pat parameters

• id (required): The ID of the request for which you want to retrieve identifications. Example: 123e4567-e89b-12d3-a456-426614174000

Example cURL API call

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

Responses

• 200 OK

  • Description: The fetched identifications.

  • Example Response:

    { "requestId": "123e4567-e89b-12d3-a456-426614174000", "identifications": [ { "id": "123e4567-e89b-12d3-a456-426614174001", "actor": "customer", "status": "COMPLETED", "source": "FACEMATCH", "finalizedAt": "2024-10-29T17:42:16Z" } ] }

• 400 Bad Request

  • Description: Bad Request described following Problem Details (RFC 9457).

  • Example Response:

    { "type": "about:blank", "status": 400, "title": "Request validation error", "detail": "The has a malformed query parameter.", "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000?ts=1729667463", "retryable": false, "errors": [ { "detail": "Parameter 'sort' is not valid.", "pointer": "/sort", "field": "sort", "reason": "invalid" } ] }