For the complete documentation index, see llms.txt. This page is also available as Markdown.

Operations query

How to check the status of a specific operation.

Through GET requests it is possible to consult the list of operations and the status of an operation associated with a operationId.

Authentication

The following credentials are required to request operation status information.

  • x-api-key: API Key for the Landing.

  • x-client-id: Client ID associated with the API Key.

This data will be provided by the Facephi team.


Services

It is possible to request the list of operations performed or the status of a specific operation through a request GET.

List of operations

To obtain the list of operations, we can use a GET request to the Endpoint https://api.landing.identity-platform.io/callback:

curl -X 'GET' \
  'https://api.landing.identity-platform.io/callback' \
  -H 'accept: application/json' \
  -H 'x-api-key: PRIVATE_API_KEY' \
  -H 'x-client-id: PRIVATE_CLIENT_ID'

This will return a response with the list of operations, with the operationId and the timestamp for each one:

Filter operations by time:

It is possible to filter the results by date/time using the following parameters:

  • startDate: Initial time. (Format: ISO 8601, Example: 2024-01-01T00:00:00Z)

  • endDate: Final time. (Format: ISO 8601, Example: 2024-12-31T23:59:59Z)

This type of request will return the filtered results with the operations carried out in that time interval.

Operation status

To obtain the status of an operation, we can use a GET request to the Endpoint https://api.landing.identity-platform.io/callback/OPERATION_ID, using the OPERATION_ID of the desired operation

Status request responses

These requests can be resolved with the following codes:

The user has finished the operation:

  • SUCCESS: The request was completed successfully.

  • DENIED: The request could not be completed due to missing credentials.

  • ERROR: The request could not be completed due to some kind of error.

The Flow has not yet been completed by the user:

  • NOT_FINISHED: The operation has not finished. More information will be found within this state:

    • reason: Reason for the status.

    • step_result: Flow status.

Example of a successful response:

Last updated