Consulta de operações

Como consultar o status de uma determinada operação.

Por meio de requisições GET, é possível consultar a listagem de operações e o status de uma operação associada a um operationId.

Autenticação

Para solicitar informações sobre o status da operação, são necessárias as seguintes credenciais.

• x-api-key: API Key da Landing.

• x-client-id: Client ID associado à API Key.

Esses dados serão fornecidos pela equipe da Facephi.

---

Serviços

É possível solicitar a listagem de operações realizadas ou o status de uma operação específica por meio de uma requisição GET.

Listagem de operações

Para obter a listagem de operações, podemos utilizar uma requisição GET para o 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'

Isso retornará uma resposta com a listagem de operações, com o operationId e o timestamp de cada uma:

{
  "operations": [
    {
      "operationId": "UNIQUE_OPERATION_ID_1",
      "timestamp": "2025-12-22T07:59:53.517Z"
    },
    {
      "operationId": "UNIQUE_OPERATION_ID_2",
      "timestamp": "2025-12-22T07:58:44.071Z"
    },
    ...
  ]
}

Filtrar operações por tempo:

É possível filtrar os resultados por data/hora com o uso dos seguintes parâmetros:

• startDate: Tempo inicial. (Formato: ISO 8601, Ex.: 2024-01-01T00:00:00Z)

• endDate: Tempo final. (Formato: ISO 8601, Ex.: 2024-12-31T23:59:59Z)

curl -X 'GET' \\
  'https://api.landing.identity-platform.io/callback?startDate=2025-12-22T07%3A52%3A57.231Z&endDate=2025-12-22T07%3A58%3A45.000Z' \\
  -H 'accept: application/json' \\
  -H 'x-api-key: PRIVATE_API_KEY' \\
  -H 'x-client-id: PRIVATE_CLIENT_ID'

Este tipo de petições devolverá os resultados filtrados com as operações realizadas nesse intervalo de tempo.

Status da operação

Para obter o status de uma operação, podemos utilizar uma requisição GET para o endpoint https://api.landing.identity-platform.io/callback/OPERATION_ID, usando o OPERATION_ID da operação desejada

curl -X 'GET' \\
  'https://api.landing.identity-platform.io/callback/b682caa8-f0da-4fc5-a373-24a3b81a889b' \\
  -H 'accept: application/json' \\
  -H 'x-api-key: PRIVATE_API_KEY' \\
  -H 'x-client-id: PRIVATE_CLIENT_ID'

Respostas das requisições de status

Essas requisições podem ser resolvidas com os seguintes códigos:

O usuário concluiu a operação:

• SUCCESS: A requisição foi realizada corretamente.

• DENIED: A requisição não pôde ser realizada por falta de credenciais.

• ERROR: A requisição não pôde ser realizada devido a algum tipo de erro.

O fluxo ainda não foi finalizado pelo usuário:

• NOT_FINISHED: A operação não foi finalizada. Dentro deste status, haverá mais informações:

  • reason: Motivo do status.

  • step_result: Status do fluxo.

Exemplo de resposta bem-sucedida:

{
  "operationId": "OPERAtION_ID",
  "operation_result": "SUCCEEDED",
  "callback_result": {
    "id": "a85b2714-1968-4306-adda-cc1b20ec04a9",
    "auth": {},
    "callback": {
      "request": {
        "url": "https://webhook.site/e8865aec-75e7-4474-87ef-69280bdde8b5",
        "method": "post",
        "header": {
          "Accept": "application/json, text/plain, */*",
          "Content-Type": "application/json",
          "User-Agent": "axios/1.5.1",
          "Content-Length": "CONTENT_LENGHT",
          "Accept-Encoding": "gzip, compress, deflate, br"
        },
        "body": "RECIEVED_DATA"
      },
      "response": {
        "status": 200,
        "body": "This URL has no default content configured. <a href=\"https://webhook.site/#!/edit/e8865aec-75e7-4474-87ef-69280bdde8b5\">Change response in Webhook.site</a>."
      }
    },
    "operationId": "OPERAtION_ID",
    "landingId": "LANDING_ID",
    "timestamp": "2025-12-15T14:00:10.755Z"
  }
}