DocumentationEngagement Platform API
Sign inGet started
Guides
API

Verify API

The verification API enables you to verify whether a user currently has access to a given phone number or email address by sending them an OTP and requesting that they verify the code sent to them.
This can be achieved by using the following API endpoints below.
Currently, Verify supports Email, WhatsApp, and SMS channels

Sending a Verification

In order to send a message, you must have an active channel and perform an HTTP request to the following endpoint using a valid access key.
POST
/workspaces/{workspaceId}/verify
Creates a new verification message
Corps de la requête
identifier
object
obligatoire
Afficher les paramètres enfants
identifier.phonenumber
string
The phone number to verify.
identifier.emailaddress
string
The email address to verify.
locale
string
The locale/language of the message sent to the user. If not provided, we will attempt to determine the locale from the user's phone number. If we are unable to determine the locale, we will default to "en-US".
maxAttempts
integer
The maximum number of attempts to verify the user. [Default: 3]
timeout
integer
The time in seconds before this verification expires. Once expired, it can no longer be verified. [Default: 600]
codeLength
integer
The length of the verification code. [Default: 6]
steps
array
obligatoire
Afficher les paramètres enfants
steps.channelId
string
obligatoire
The channel ID to send the message through.
steps.template
object
Afficher les paramètres enfants
steps.template.name
string
The platform name of the template.
steps.template.projectId
string
the ID of the project from the project from Studio
steps.template.version
string
The version of the template.
steps.template.locale
string
steps.template.attachments
array of object
Afficher les paramètres enfants
steps.template.attachments.mediaUrl
string
obligatoire
The URL of the attachment.
steps.template.attachments.filename
string
obligatoire
The filename of the attachment.
steps.template.attachments.inline
boolean
steps.template.shortLinks
object
SMS link shortening options.
Afficher les paramètres enfants
steps.template.shortLinks.enabled
boolean
Enables link shortening for SMS messages.
steps.template.shortLinks.domain
string
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
steps.template.variables
object
Deprecated: Use parameters instead (string parameter for variables). This property is maintained for backward compatibility but will be removed in a future version.
Afficher les paramètres enfants
steps.template.variables.default
string
steps.template.utmParameters
array of object
The list of UTM parameters.
Afficher les paramètres enfants
steps.template.utmParameters.key
string
obligatoire
The name of the parameter in the query string.
steps.template.utmParameters.value
string
obligatoire
The static value of the parameter. Mutually exclusive with Reference.
steps.template.parameters
array of object
Afficher les paramètres enfants
steps.template.parameters.type
string
obligatoire
Possible values: string
steps.template.parameters.key
string
obligatoire
steps.template.parameters.value
string
steps.template.settings
object
Afficher les paramètres enfants
steps.template.settings.disallowMmLite
boolean
This is specific for WhatsApp marketing templates and requires MM Lite to be disabled for the WABAID.
steps.email
object
Optional email configuration for email verification steps.
Afficher les paramètres enfants
steps.email.from
object
Custom sender address configuration.
Afficher les paramètres enfants
steps.email.from.username
string
The local part of the sender email address. The domain is derived from the email channel configuration.
steps.email.from.displayName
string
The display name of the sender.
Corps de la réponse
id
string
identifier
object
Afficher les attributs enfants
identifier.phonenumber
string
The phone number to verify.
identifier.emailaddress
string
The email address to verify.
locale
string
The locale/language of the message sent to the user. If not provided, we will attempt to determine the locale from the user's phone number. If we are unable to determine the locale, we will default to "en-US".
maxAttempts
integer
The maximum number of attempts to verify the user. [Default: 3]
failedAttempts
integer
The number of times an attempt was made to verify with an incorrect code.
timeout
integer
The time in seconds before this verification expires. Once expired, it can no longer be verified. [Default: 600]
codeLength
integer
The length of the verification code. [Default: 6]
status
string
The current status of the verification.
Possible values: accepted, pending, verified, failed, expired, canceled
currentStepIndex
integer
The index of the current active step in the steps array.
steps
array of object
Afficher les attributs enfants
steps.channelId
string
steps.navigatorId
string
steps.identifier
string
steps.template
object
Afficher les attributs enfants
steps.template.name
string
The platform name of the template.
steps.template.projectId
string
the ID of the project from the project from Studio
steps.template.version
string
The version of the template.
steps.template.locale
string
steps.template.attachments
array of object
Afficher les attributs enfants
steps.template.attachments.mediaUrl
string
obligatoire
The URL of the attachment.
steps.template.attachments.filename
string
obligatoire
The filename of the attachment.
steps.template.attachments.inline
boolean
steps.template.shortLinks
object
SMS link shortening options.
Afficher les attributs enfants
steps.template.shortLinks.enabled
boolean
Enables link shortening for SMS messages.
steps.template.shortLinks.domain
string
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
steps.template.variables
object
Deprecated: Use parameters instead (string parameter for variables). This property is maintained for backward compatibility but will be removed in a future version.
Afficher les attributs enfants
steps.template.variables.default
string
steps.template.utmParameters
array of object
The list of UTM parameters.
Afficher les attributs enfants
steps.template.utmParameters.key
string
obligatoire
The name of the parameter in the query string.
steps.template.utmParameters.value
string
obligatoire
The static value of the parameter. Mutually exclusive with Reference.
steps.template.parameters
array of object
Afficher les attributs enfants
steps.template.parameters.type
string
obligatoire
Possible values: string
steps.template.parameters.key
string
obligatoire
steps.template.parameters.value
string
steps.template.settings
object
Afficher les attributs enfants
steps.template.settings.disallowMmLite
boolean
This is specific for WhatsApp marketing templates and requires MM Lite to be disabled for the WABAID.
steps.email
object
Email configuration for this verification step.
Afficher les attributs enfants
steps.email.from
object
Custom sender address configuration.
Afficher les attributs enfants
steps.email.from.username
string
The local part of the sender email address.
steps.email.from.displayName
string
The display name of the sender.
steps.status
string
Possible values: unused, prepared, pending, verified, failed
steps.attempts
array of object
Afficher les attributs enfants
steps.attempts.messageId
string
steps.attempts.status
string
Possible values: prepared, accepted, processing, scheduled, sent, sending_failed, delivered, delivery_failed, deleted
steps.attempts.verified
boolean
steps.attempts.sentAt
string
steps.attempts.verifiedAt
string
createdAt
string
The time the verification was created.
updatedAt
string
The time the verification was last updated.
expiresAt
string
The time after which the verification can no longer be verified.
Exemple de code
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/verify' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
Here is an example of a basic verify request body for SMS
Exemple de code
{
  "identifier": {
    "phonenumber": "+31623456789"
  },
  "steps": [
    {
      "channelId": "SMS_CHANNEL_UUID"
    }
  ]
}

Steps

You can use Steps to implement a failover strategy between different channels. The minimum number of steps is one. Calling the failover endpoint will cause it to move to the next step.
Exemple de code
{
  "identifier": {
    "phonenumber": "+31623456789",
    "emailaddress": "name@example.com"
  },
  "locale": "en-US",
  "maxAttempts": 3,
  "timeout": 300,
  "codeLength": 6,
  "steps": [
    {
      "channelId": "CHANNEL_UUID"
    },
    {
      "channelId": "FAILOVER_CHANNEL_UUID"
    }
  ]
}
Instead of using an SMS channel step, use an SMS navigator. Navigators offer two key advantages:
  • Improve Reliability: Your integration remains consistent, preventing any changes, additions, or deletions to your channels from impacting your verification requests.
  • Improved Coverage: The best available channel will be used based on the country of the number you are trying to verify, increasing your conversion rate.
You can achieve this by using the following syntax, based on the UUID you can find in Developers -> Navigators -> Navigator Setup -> OTP:
Exemple de code
"steps": [
    {
        "navigatorId": "OTP_navigator_UUID"
    }
]

Email steps

For steps referencing an email channel, you can provide additional information on the step configuration to set the sender. Given you have an email channel set up with the acme.com domain, the snippet below would trigger an email from ACME <verify@acme.com>.
Exemple de code
{
  "steps": [
    {
      "channelId": "EMAIL_CHANNEL_UUID",
      "email": {
        "from": {
          "username": "verify",
          "displayName": "ACME"
        }
      }
    }
  ]
}

Templates

Verify supports using templates for some channels. The following is an example of using a channel with a template.
Exemple de code
{
  "identifier": {
    "phonenumber": "+31623456789",
  },
  "steps": [
    {
      "channelId": "CHANNEL_UUID",
      "template": {
        "projectId": "TEMPLATE_UUID",
        "version": "TEMPLATE_VERSION_UUID|latest",
        "locale": "en"
      }
    }
  ]
}

SMS Templates

Sending SMS Verify messages can be done in two ways:
  1. Using our pre-defined message body. You can change the language by setting the locale of the verification; the body language is derived from the given locale.
    1. Supported languages include:
      1. Afrikaans (af)
      2. Arabic (ar)
      3. German (de)
      4. English (en)
      5. Spanish (es)
      6. French (fr)
      7. Italian (it)
      8. Dutch (nl)
      9. Polish (pl)
      10. Portuguese (pt)
      11. Russian (ru)
      12. Turkish (tr)
      13. Finnish (fi)
      14. Norwegian (nb, no)
      15. Swedish (sv)
      16. Czech (cs)
  2. Using a customer-defined template. The template should contain a variable named otp which is used for the generated OTP Code.

Email Templates

For emails, templates work just as you would expect via the channels API, with the addition of a variable for the Verify OTP Code.
When setting up a template for Email, select {} -> Verify -> OTP from the list of variables

WhatsApp Templates

Templates for WhatsApp channels are required. To send an OTP message to a WhatsApp channel, you must have an Authentication Template set up.

Verifying the code

Once you have received a code from one of your users, you will have to confirm if the code is valid.
POST
/workspaces/{workspaceId}/verify/{verificationId}
Verifies a code of a verification message
Corps de la requête
code
string
obligatoire
Corps de la réponse
id
string
identifier
object
Afficher les attributs enfants
identifier.phonenumber
string
The phone number to verify.
identifier.emailaddress
string
The email address to verify.
locale
string
The locale/language of the message sent to the user. If not provided, we will attempt to determine the locale from the user's phone number. If we are unable to determine the locale, we will default to "en-US".
maxAttempts
integer
The maximum number of attempts to verify the user. [Default: 3]
failedAttempts
integer
The number of times an attempt was made to verify with an incorrect code.
timeout
integer
The time in seconds before this verification expires. Once expired, it can no longer be verified. [Default: 600]
codeLength
integer
The length of the verification code. [Default: 6]
status
string
The current status of the verification.
Possible values: accepted, pending, verified, failed, expired, canceled
currentStepIndex
integer
The index of the current active step in the steps array.
steps
array of object
Afficher les attributs enfants
steps.channelId
string
steps.navigatorId
string
steps.identifier
string
steps.template
object
Afficher les attributs enfants
steps.template.name
string
The platform name of the template.
steps.template.projectId
string
the ID of the project from the project from Studio
steps.template.version
string
The version of the template.
steps.template.locale
string
steps.template.attachments
array of object
Afficher les attributs enfants
steps.template.attachments.mediaUrl
string
obligatoire
The URL of the attachment.
steps.template.attachments.filename
string
obligatoire
The filename of the attachment.
steps.template.attachments.inline
boolean
steps.template.shortLinks
object
SMS link shortening options.
Afficher les attributs enfants
steps.template.shortLinks.enabled
boolean
Enables link shortening for SMS messages.
steps.template.shortLinks.domain
string
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
steps.template.variables
object
Deprecated: Use parameters instead (string parameter for variables). This property is maintained for backward compatibility but will be removed in a future version.
Afficher les attributs enfants
steps.template.variables.default
string
steps.template.utmParameters
array of object
The list of UTM parameters.
Afficher les attributs enfants
steps.template.utmParameters.key
string
obligatoire
The name of the parameter in the query string.
steps.template.utmParameters.value
string
obligatoire
The static value of the parameter. Mutually exclusive with Reference.
steps.template.parameters
array of object
Afficher les attributs enfants
steps.template.parameters.type
string
obligatoire
Possible values: string
steps.template.parameters.key
string
obligatoire
steps.template.parameters.value
string
steps.template.settings
object
Afficher les attributs enfants
steps.template.settings.disallowMmLite
boolean
This is specific for WhatsApp marketing templates and requires MM Lite to be disabled for the WABAID.
steps.email
object
Email configuration for this verification step.
Afficher les attributs enfants
steps.email.from
object
Custom sender address configuration.
Afficher les attributs enfants
steps.email.from.username
string
The local part of the sender email address.
steps.email.from.displayName
string
The display name of the sender.
steps.status
string
Possible values: unused, prepared, pending, verified, failed
steps.attempts
array of object
Afficher les attributs enfants
steps.attempts.messageId
string
steps.attempts.status
string
Possible values: prepared, accepted, processing, scheduled, sent, sending_failed, delivered, delivery_failed, deleted
steps.attempts.verified
boolean
steps.attempts.sentAt
string
steps.attempts.verifiedAt
string
createdAt
string
The time the verification was created.
updatedAt
string
The time the verification was last updated.
expiresAt
string
The time after which the verification can no longer be verified.
Exemple de code
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/verify/{verificationId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Resend a code for a specific verification step

Using the following endpoint, you can also resend a message for a given verification step.
By not setting a value for stepIndex, it will default to the currently active step.
POST
/workspaces/{workspaceId}/verify/{verificationId}/resend
Attempt resending a verification code for a given step
Corps de la requête
stepIndex
integer
The index of the step to use.
Corps de la réponse
id
string
identifier
object
Afficher les attributs enfants
identifier.phonenumber
string
The phone number to verify.
identifier.emailaddress
string
The email address to verify.
locale
string
The locale/language of the message sent to the user. If not provided, we will attempt to determine the locale from the user's phone number. If we are unable to determine the locale, we will default to "en-US".
maxAttempts
integer
The maximum number of attempts to verify the user. [Default: 3]
failedAttempts
integer
The number of times an attempt was made to verify with an incorrect code.
timeout
integer
The time in seconds before this verification expires. Once expired, it can no longer be verified. [Default: 600]
codeLength
integer
The length of the verification code. [Default: 6]
status
string
The current status of the verification.
Possible values: accepted, pending, verified, failed, expired, canceled
currentStepIndex
integer
The index of the current active step in the steps array.
steps
array of object
Afficher les attributs enfants
steps.channelId
string
steps.navigatorId
string
steps.identifier
string
steps.template
object
Afficher les attributs enfants
steps.template.name
string
The platform name of the template.
steps.template.projectId
string
the ID of the project from the project from Studio
steps.template.version
string
The version of the template.
steps.template.locale
string
steps.template.attachments
array of object
Afficher les attributs enfants
steps.template.attachments.mediaUrl
string
obligatoire
The URL of the attachment.
steps.template.attachments.filename
string
obligatoire
The filename of the attachment.
steps.template.attachments.inline
boolean
steps.template.shortLinks
object
SMS link shortening options.
Afficher les attributs enfants
steps.template.shortLinks.enabled
boolean
Enables link shortening for SMS messages.
steps.template.shortLinks.domain
string
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
steps.template.variables
object
Deprecated: Use parameters instead (string parameter for variables). This property is maintained for backward compatibility but will be removed in a future version.
Afficher les attributs enfants
steps.template.variables.default
string
steps.template.utmParameters
array of object
The list of UTM parameters.
Afficher les attributs enfants
steps.template.utmParameters.key
string
obligatoire
The name of the parameter in the query string.
steps.template.utmParameters.value
string
obligatoire
The static value of the parameter. Mutually exclusive with Reference.
steps.template.parameters
array of object
Afficher les attributs enfants
steps.template.parameters.type
string
obligatoire
Possible values: string
steps.template.parameters.key
string
obligatoire
steps.template.parameters.value
string
steps.template.settings
object
Afficher les attributs enfants
steps.template.settings.disallowMmLite
boolean
This is specific for WhatsApp marketing templates and requires MM Lite to be disabled for the WABAID.
steps.email
object
Email configuration for this verification step.
Afficher les attributs enfants
steps.email.from
object
Custom sender address configuration.
Afficher les attributs enfants
steps.email.from.username
string
The local part of the sender email address.
steps.email.from.displayName
string
The display name of the sender.
steps.status
string
Possible values: unused, prepared, pending, verified, failed
steps.attempts
array of object
Afficher les attributs enfants
steps.attempts.messageId
string
steps.attempts.status
string
Possible values: prepared, accepted, processing, scheduled, sent, sending_failed, delivered, delivery_failed, deleted
steps.attempts.verified
boolean
steps.attempts.sentAt
string
steps.attempts.verifiedAt
string
createdAt
string
The time the verification was created.
updatedAt
string
The time the verification was last updated.
expiresAt
string
The time after which the verification can no longer be verified.
Exemple de code
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/verify/{verificationId}/resend' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Failover to the next step

You can failover to another verification step by calling the following endpoint.
By not setting a value for stepIndex, it will default to the next step in the array.
Auto Failover
Verify will automatically failover to the next step when a step fails to send or deliver, provided the next step is on a different platform.
Examples:
  1. Different Platforms:
    • If two steps are used: the 1st is WhatsApp, and the 2nd is SMS, the SMS will automatically be sent if the WhatsApp message fails to send or deliver.
    • If two steps are used: the 1st is SMS, and the 2nd is Email, the email will automatically be sent if the SMS fails to send or deliver.
  2. Same Platform:
    • If two steps are used, and both are SMS, the second SMS will not be automatically selected if the first SMS fails.
    • This is because Bird assumes that if one type of SMS fails, all SMS will fail, as they rely on the same infrastructure.
POST
/workspaces/{workspaceId}/verify/{verificationId}/failover
Failover to the next step of the verification process
Corps de la requête
stepIndex
integer
The index of the step to use.
Corps de la réponse
id
string
identifier
object
Afficher les attributs enfants
identifier.phonenumber
string
The phone number to verify.
identifier.emailaddress
string
The email address to verify.
locale
string
The locale/language of the message sent to the user. If not provided, we will attempt to determine the locale from the user's phone number. If we are unable to determine the locale, we will default to "en-US".
maxAttempts
integer
The maximum number of attempts to verify the user. [Default: 3]
failedAttempts
integer
The number of times an attempt was made to verify with an incorrect code.
timeout
integer
The time in seconds before this verification expires. Once expired, it can no longer be verified. [Default: 600]
codeLength
integer
The length of the verification code. [Default: 6]
status
string
The current status of the verification.
Possible values: accepted, pending, verified, failed, expired, canceled
currentStepIndex
integer
The index of the current active step in the steps array.
steps
array of object
Afficher les attributs enfants
steps.channelId
string
steps.navigatorId
string
steps.identifier
string
steps.template
object
Afficher les attributs enfants
steps.template.name
string
The platform name of the template.
steps.template.projectId
string
the ID of the project from the project from Studio
steps.template.version
string
The version of the template.
steps.template.locale
string
steps.template.attachments
array of object
Afficher les attributs enfants
steps.template.attachments.mediaUrl
string
obligatoire
The URL of the attachment.
steps.template.attachments.filename
string
obligatoire
The filename of the attachment.
steps.template.attachments.inline
boolean
steps.template.shortLinks
object
SMS link shortening options.
Afficher les attributs enfants
steps.template.shortLinks.enabled
boolean
Enables link shortening for SMS messages.
steps.template.shortLinks.domain
string
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
steps.template.variables
object
Deprecated: Use parameters instead (string parameter for variables). This property is maintained for backward compatibility but will be removed in a future version.
Afficher les attributs enfants
steps.template.variables.default
string
steps.template.utmParameters
array of object
The list of UTM parameters.
Afficher les attributs enfants
steps.template.utmParameters.key
string
obligatoire
The name of the parameter in the query string.
steps.template.utmParameters.value
string
obligatoire
The static value of the parameter. Mutually exclusive with Reference.
steps.template.parameters
array of object
Afficher les attributs enfants
steps.template.parameters.type
string
obligatoire
Possible values: string
steps.template.parameters.key
string
obligatoire
steps.template.parameters.value
string
steps.template.settings
object
Afficher les attributs enfants
steps.template.settings.disallowMmLite
boolean
This is specific for WhatsApp marketing templates and requires MM Lite to be disabled for the WABAID.
steps.email
object
Email configuration for this verification step.
Afficher les attributs enfants
steps.email.from
object
Custom sender address configuration.
Afficher les attributs enfants
steps.email.from.username
string
The local part of the sender email address.
steps.email.from.displayName
string
The display name of the sender.
steps.status
string
Possible values: unused, prepared, pending, verified, failed
steps.attempts
array of object
Afficher les attributs enfants
steps.attempts.messageId
string
steps.attempts.status
string
Possible values: prepared, accepted, processing, scheduled, sent, sending_failed, delivered, delivery_failed, deleted
steps.attempts.verified
boolean
steps.attempts.sentAt
string
steps.attempts.verifiedAt
string
createdAt
string
The time the verification was created.
updatedAt
string
The time the verification was last updated.
expiresAt
string
The time after which the verification can no longer be verified.
Exemple de code
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/verify/{verificationId}/failover' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Retrieving Verifications

Retrieving a list of Verifications

GET
/workspaces/{workspaceId}/verify
List all verifications for this workspace
Paramètres de requête
limit
integer
Limits the number of results to return.
pageToken
string
The cursor that keeps track of the current position in the results.
reverse
boolean
Reverses the order in which the results are returned.
startAt
string
Start date for the query
endAt
string
End date for the query
Corps de la réponse
nextPageToken
string
The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.
results
array of object
Afficher les attributs enfants
results.id
string
results.identifier
object
Afficher les attributs enfants
results.identifier.phonenumber
string
The phone number to verify.
results.identifier.emailaddress
string
The email address to verify.
results.locale
string
The locale/language of the message sent to the user. If not provided, we will attempt to determine the locale from the user's phone number. If we are unable to determine the locale, we will default to "en-US".
results.maxAttempts
integer
The maximum number of attempts to verify the user. [Default: 3]
results.failedAttempts
integer
The number of times an attempt was made to verify with an incorrect code.
results.timeout
integer
The time in seconds before this verification expires. Once expired, it can no longer be verified. [Default: 600]
results.codeLength
integer
The length of the verification code. [Default: 6]
results.status
string
The current status of the verification.
Possible values: accepted, pending, verified, failed, expired, canceled
results.currentStepIndex
integer
The index of the current active step in the steps array.
results.steps
array of object
Afficher les attributs enfants
results.steps.channelId
string
results.steps.navigatorId
string
results.steps.identifier
string
results.steps.template
object
Afficher les attributs enfants
results.steps.template.name
string
The platform name of the template.
results.steps.template.projectId
string
the ID of the project from the project from Studio
results.steps.template.version
string
The version of the template.
results.steps.template.locale
string
results.steps.template.attachments
array of object
Afficher les attributs enfants
results.steps.template.attachments.mediaUrl
string
obligatoire
The URL of the attachment.
results.steps.template.attachments.filename
string
obligatoire
The filename of the attachment.
results.steps.template.attachments.inline
boolean
results.steps.template.shortLinks
object
SMS link shortening options.
Afficher les attributs enfants
results.steps.template.shortLinks.enabled
boolean
Enables link shortening for SMS messages.
results.steps.template.shortLinks.domain
string
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
results.steps.template.variables
object
Deprecated: Use parameters instead (string parameter for variables). This property is maintained for backward compatibility but will be removed in a future version.
Afficher les attributs enfants
results.steps.template.variables.default
string
results.steps.template.utmParameters
array of object
The list of UTM parameters.
Afficher les attributs enfants
results.steps.template.utmParameters.key
string
obligatoire
The name of the parameter in the query string.
results.steps.template.utmParameters.value
string
obligatoire
The static value of the parameter. Mutually exclusive with Reference.
results.steps.template.parameters
array of object
Afficher les attributs enfants
results.steps.template.parameters.type
string
obligatoire
Possible values: string
results.steps.template.parameters.key
string
obligatoire
results.steps.template.parameters.value
string
results.steps.template.settings
object
Afficher les attributs enfants
results.steps.template.settings.disallowMmLite
boolean
This is specific for WhatsApp marketing templates and requires MM Lite to be disabled for the WABAID.
results.steps.email
object
Email configuration for this verification step.
Afficher les attributs enfants
results.steps.email.from
object
Custom sender address configuration.
Afficher les attributs enfants
results.steps.email.from.username
string
The local part of the sender email address.
results.steps.email.from.displayName
string
The display name of the sender.
results.steps.status
string
Possible values: unused, prepared, pending, verified, failed
results.steps.attempts
array of object
Afficher les attributs enfants
results.steps.attempts.messageId
string
results.steps.attempts.status
string
Possible values: prepared, accepted, processing, scheduled, sent, sending_failed, delivered, delivery_failed, deleted
results.steps.attempts.verified
boolean
results.steps.attempts.sentAt
string
results.steps.attempts.verifiedAt
string
results.createdAt
string
The time the verification was created.
results.updatedAt
string
The time the verification was last updated.
results.expiresAt
string
The time after which the verification can no longer be verified.
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/verify' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Retrieving a single Verification

GET
/workspaces/{workspaceId}/verify/{verificationId}
Get a verification message
Corps de la réponse
id
string
identifier
object
Afficher les attributs enfants
identifier.phonenumber
string
The phone number to verify.
identifier.emailaddress
string
The email address to verify.
locale
string
The locale/language of the message sent to the user. If not provided, we will attempt to determine the locale from the user's phone number. If we are unable to determine the locale, we will default to "en-US".
maxAttempts
integer
The maximum number of attempts to verify the user. [Default: 3]
failedAttempts
integer
The number of times an attempt was made to verify with an incorrect code.
timeout
integer
The time in seconds before this verification expires. Once expired, it can no longer be verified. [Default: 600]
codeLength
integer
The length of the verification code. [Default: 6]
status
string
The current status of the verification.
Possible values: accepted, pending, verified, failed, expired, canceled
currentStepIndex
integer
The index of the current active step in the steps array.
steps
array of object
Afficher les attributs enfants
steps.channelId
string
steps.navigatorId
string
steps.identifier
string
steps.template
object
Afficher les attributs enfants
steps.template.name
string
The platform name of the template.
steps.template.projectId
string
the ID of the project from the project from Studio
steps.template.version
string
The version of the template.
steps.template.locale
string
steps.template.attachments
array of object
Afficher les attributs enfants
steps.template.attachments.mediaUrl
string
obligatoire
The URL of the attachment.
steps.template.attachments.filename
string
obligatoire
The filename of the attachment.
steps.template.attachments.inline
boolean
steps.template.shortLinks
object
SMS link shortening options.
Afficher les attributs enfants
steps.template.shortLinks.enabled
boolean
Enables link shortening for SMS messages.
steps.template.shortLinks.domain
string
The domain to use when shortening links. When set to default, uses the default link shortening domain for the workspace.
steps.template.variables
object
Deprecated: Use parameters instead (string parameter for variables). This property is maintained for backward compatibility but will be removed in a future version.
Afficher les attributs enfants
steps.template.variables.default
string
steps.template.utmParameters
array of object
The list of UTM parameters.
Afficher les attributs enfants
steps.template.utmParameters.key
string
obligatoire
The name of the parameter in the query string.
steps.template.utmParameters.value
string
obligatoire
The static value of the parameter. Mutually exclusive with Reference.
steps.template.parameters
array of object
Afficher les attributs enfants
steps.template.parameters.type
string
obligatoire
Possible values: string
steps.template.parameters.key
string
obligatoire
steps.template.parameters.value
string
steps.template.settings
object
Afficher les attributs enfants
steps.template.settings.disallowMmLite
boolean
This is specific for WhatsApp marketing templates and requires MM Lite to be disabled for the WABAID.
steps.email
object
Email configuration for this verification step.
Afficher les attributs enfants
steps.email.from
object
Custom sender address configuration.
Afficher les attributs enfants
steps.email.from.username
string
The local part of the sender email address.
steps.email.from.displayName
string
The display name of the sender.
steps.status
string
Possible values: unused, prepared, pending, verified, failed
steps.attempts
array of object
Afficher les attributs enfants
steps.attempts.messageId
string
steps.attempts.status
string
Possible values: prepared, accepted, processing, scheduled, sent, sending_failed, delivered, delivery_failed, deleted
steps.attempts.verified
boolean
steps.attempts.sentAt
string
steps.attempts.verifiedAt
string
createdAt
string
The time the verification was created.
updatedAt
string
The time the verification was last updated.
expiresAt
string
The time after which the verification can no longer be verified.
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/verify/{verificationId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'