Sign inGet Started

Get an authentication request

GET
/v1/amb/conversations/{conversation_id}/authentications/{authentication_id}
curl -X GET "https://us1.platform.bird.com/v1/amb/conversations/{conversation_id}/authentications/{authentication_id}" \
  -H "Authorization: Bearer $TOKEN"
Risposta200
{
  "id": "amauth_01krdgeqcxet5s7t44vh8rt9mg",
  "conversation_id": "acv_01krdgeqcxet5s7t44vh8rt9mg",
  "provider_id": "aauthp_01krdgeqcxet5s7t44vh8rt9mg",
  "message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg",
  "status": "pending"
}

Returns one authentication request with its current status. A request that succeeded includes the verified identity. Read it to recover the outcome when the webhook event for the request was not received.

Parametri

conversation_idstring

Conversation identifier. Starts with acv_.

authentication_idstring

Authentication request identifier. Starts with amauth_.

Payload di risposta

id
string
obbligatorio
conversation_id
string
obbligatorio
provider_id
string
obbligatorio
provider_revision
integer
obbligatorio

Provider revision used by this attempt.

message_id
nullable string
obbligatorio

Authentication message reference, or null before acceptance.

status
string
obbligatorio

Progress of an authentication request. Every value except pending and processing is terminal.

  • pending: the sign-in message was accepted and the customer has not finished.
  • processing: the authorization code is being exchanged or Bird is waiting for confirmation from the originating Messages device.
  • succeeded: the identity was validated and the originating Messages device confirmed sign-in.
  • failed: delivery, identity verification or device confirmation failed, or the provider callback was replayed.
  • cancelled: the customer or the provider declined authorization.
  • expired: the request passed its ten-minute lifetime.
  • superseded: a newer request, or a change to the conversation, business or provider, replaced the request.

Possible values: pending, processing, succeeded, failed, cancelled, expired, superseded

created_at
string
obbligatorio

When the attempt was created.

expires_at
string
obbligatorio

When this attempt expires.

completed_at
string

When the attempt reached a terminal outcome.

failure_code
string

Why the request did not succeed. Contains no provider response or credentials.

  • authentication_expired: ten minutes passed. Request a new sign-in.
  • new_authentication: a newer request replaced this one.
  • conversation_closed and conversation_changed: the conversation closed or reopened. Wait for the customer to write again.
  • configuration_changed: the provider settings changed or the business was disconnected.
  • user_cancelled, apple_authentication_cancel: the customer declined.
  • provider_rejected, token_exchange_failed, identity_verification_failed: the provider response could not be accepted. Check the provider settings, then request a new sign-in.
  • processing_interrupted: the exchange or device confirmation did not finish within one minute. Ask the customer to sign in again and return to Messages.
  • apple_authentication_failure: the Messages device reported a failed sign-in. Request a new sign-in.
  • authentication_replayed: the provider callback was used more than once. Request a new sign-in.
  • message_submission_failed, message_failed: the sign-in message could not be sent.

Other values are message delivery reasons passed through unchanged.

identity
object

Validated identity claims. Verification does not create a persistent login session or grant access to customer systems.

Mostra attributi secondari

Continua con la documentazione, le guide e gli esempi per questo argomento.