Sign inGet started

bird trust gates verification create

Usage

Exemple de code
bird trust gates verification create <slug> [flags]

Description

Create a trust-gate verification
What comes back decides who finishes it. A provider-hosted requirement answers with hosted_url: hand that link to the person whose identity is being checked and stop there, because only they can complete it. A requirement verified with a one-time code answers with the channel and a masked destination instead, and you finish it with bird trust gates verification check once they read the code back to you. Pass no destination for the hosted kind.
Build the request from flags, a JSON TrustVerificationStart body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Exemple de code
# print the body shape (no credentials needed)
bird trust gates verification create --example

# the body it prints:
Exemple de code
{
  "email": "alex@example.com"
}

Options

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--emailWhere to send the one-time code, for a requirement verified that way. Omit for a provider-hosted requirement, which returns a link instead. Pass this or --phone-number, never both.
--phone-numberWhere to send the one-time code, in E.164. Omit for a provider-hosted requirement. Pass this or --email, never both.
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird trust gates verification checkVerify a trust-gate code