components: securitySchemes: accountSid_authToken: scheme: basic type: http schemas: verify.v2.service.access_token: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^YK[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this Access Token. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Verify Service. entity_identity: type: string nullable: true description: The unique external identifier for the Entity of the Service. factor_type: $ref: '#/components/schemas/access_token_enum_factor_types' factor_friendly_name: type: string nullable: true description: A human readable description of this factor, up to 64 characters. For a push factor, this can be the device's name. x-twilio: pii: handling: standard deleteSla: 30 token: type: string nullable: true description: The access token generated for enrollment, this is an encrypted json web token. url: type: string format: uri nullable: true description: The URL of this resource. ttl: type: integer default: 0 description: 'How long, in seconds, the access token is valid. Max: 5 minutes' date_created: type: string format: date-time nullable: true description: The date that this access token was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. access_token_enum_factor_types: type: string enum: - push description: The Type of the Factor. Currently only `push` is supported. verify.v2.service.rate_limit.bucket: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^BL[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this Bucket. rate_limit_sid: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ nullable: true description: The Twilio-provided string that uniquely identifies the Rate Limit resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Rate Limit resource. max: type: integer default: 0 description: Maximum number of requests permitted in during the interval. interval: type: integer default: 0 description: Number of seconds that the rate limit will be enforced over. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. url: type: string format: uri nullable: true description: The URL of this resource. verify.v2.service.entity.challenge: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^YC[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this Challenge. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Service. entity_sid: type: string minLength: 34 maxLength: 34 pattern: ^YE[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Entity. identity: type: string nullable: true description: Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. x-twilio: pii: handling: standard deleteSla: 30 factor_sid: type: string minLength: 34 maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Factor. date_created: type: string format: date-time nullable: true description: The date that this Challenge was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date that this Challenge was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_responded: type: string format: date-time nullable: true description: The date that this Challenge was responded, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. expiration_date: type: string format: date-time nullable: true description: The date-time when this Challenge expires, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The default value is five (5) minutes after Challenge creation. The max value is sixty (60) minutes after creation. status: $ref: '#/components/schemas/challenge_enum_challenge_statuses' responded_reason: $ref: '#/components/schemas/challenge_enum_challenge_reasons' details: nullable: true description: Details provided to give context about the Challenge. Intended to be shown to the end user. x-twilio: pii: handling: standard deleteSla: 30 hidden_details: nullable: true description: 'Details provided to give context about the Challenge. Intended to be hidden from the end user. It must be a stringified JSON with only strings values eg. `{"ip": "172.168.1.234"}`' x-twilio: pii: handling: standard deleteSla: 30 metadata: nullable: true description: 'Custom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' x-twilio: pii: handling: standard deleteSla: 30 factor_type: $ref: '#/components/schemas/challenge_enum_factor_types' url: type: string format: uri nullable: true description: The URL of this resource. links: type: object format: uri-map nullable: true description: Contains a dictionary of URL links to nested resources of this Challenge. challenge_enum_challenge_statuses: type: string enum: - pending - expired - approved - denied description: The Status of this Challenge. One of `pending`, `expired`, `approved` or `denied`. challenge_enum_challenge_reasons: type: string enum: - none - not_needed - not_requested description: Reason for the Challenge to be in certain `status`. One of `none`, `not_needed` or `not_requested`. challenge_enum_factor_types: type: string enum: - push - totp description: The Factor Type of this Challenge. Currently `push` and `totp` are supported. challenge_enum_list_orders: type: string enum: - asc - desc verify.v2.service.entity: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^YE[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this Entity. identity: type: string nullable: true description: The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. x-twilio: pii: handling: standard deleteSla: 30 account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Service. date_created: type: string format: date-time nullable: true description: The date that this Entity was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date that this Entity was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The URL of this resource. links: type: object format: uri-map nullable: true description: Contains a dictionary of URL links to nested resources of this Entity. verify.v2.service.entity.factor: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this Factor. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Service. entity_sid: type: string minLength: 34 maxLength: 34 pattern: ^YE[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Entity. identity: type: string nullable: true description: Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. x-twilio: pii: handling: standard deleteSla: 30 date_created: type: string format: date-time nullable: true description: The date that this Factor was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date that this Factor was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. friendly_name: type: string nullable: true description: A human readable description of this resource, up to 64 characters. For a push factor, this can be the device's name. status: $ref: '#/components/schemas/factor_enum_factor_statuses' factor_type: $ref: '#/components/schemas/factor_enum_factor_types' config: nullable: true description: An object that contains configurations specific to a `factor_type`. metadata: nullable: true description: 'Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' x-twilio: pii: handling: standard deleteSla: 30 url: type: string format: uri nullable: true description: The URL of this resource. factor_enum_factor_statuses: type: string enum: - unverified - verified description: The Status of this Factor. One of `unverified` or `verified`. factor_enum_factor_types: type: string enum: - push - totp description: The Type of this Factor. Currently `push` and `totp` are supported. factor_enum_notification_platforms: type: string enum: - apn - fcm - none factor_enum_totp_algorithms: type: string enum: - sha1 - sha256 - sha512 verify.v2.form: type: object properties: form_type: $ref: '#/components/schemas/form_enum_form_types' forms: nullable: true description: Object that contains the available forms for this type. This available forms are given in the standard [JSON Schema](https://json-schema.org/) format form_meta: nullable: true description: Additional information for the available forms for this type. E.g. The separator string used for `binding` in a Factor push. url: type: string format: uri nullable: true description: The URL to access the forms for this type. form_enum_form_types: type: string enum: - form-push description: The Type of this Form. Currently only `form-push` is supported. verify.v2.service.messaging_configuration: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with. country: type: string nullable: true description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. url: type: string format: uri nullable: true description: The URL of this resource. verify.v2.service.entity.new_factor: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this Factor. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Service. entity_sid: type: string minLength: 34 maxLength: 34 pattern: ^YE[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Entity. identity: type: string nullable: true description: Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. x-twilio: pii: handling: standard deleteSla: 30 binding: nullable: true description: "Contains the `factor_type` specific secret and metadata.\n\ For push, this is `binding.public_key` and `binding.alg`.\nFor totp, this\ \ is `binding.secret` and `binding.uri`. The `binding.uri` property is\ \ generated following the [google authenticator key URI format](https://github.com/google/google-authenticator/wiki/Key-Uri-Format),\ \ and `Factor.friendly_name` is used for the \u201Caccountname\u201D value\ \ and `Service.friendly_name` or `Service.totp.issuer` is used for the\ \ `issuer` value.\n\n\nThe Binding property is ONLY returned upon Factor\ \ creation." date_created: type: string format: date-time nullable: true description: The date that this Factor was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date that this Factor was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. friendly_name: type: string nullable: true description: "The friendly name of this Factor. This can be any string up\ \ to 64 characters, meant for humans to distinguish between Factors.\n\ For `factor_type` `push`, this could be a device name.\nFor `factor_type`\ \ `totp`, this value is used as the \u201Caccount name\u201D in constructing\ \ the `binding.uri` property.\nAt the same time, we recommend avoiding\ \ providing PII." status: $ref: '#/components/schemas/new_factor_enum_factor_statuses' factor_type: $ref: '#/components/schemas/new_factor_enum_factor_types' config: nullable: true description: An object that contains configurations specific to a `factor_type`. metadata: nullable: true description: 'Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' x-twilio: pii: handling: standard deleteSla: 30 url: type: string format: uri nullable: true description: The URL of this resource. new_factor_enum_factor_statuses: type: string enum: - unverified - verified description: The Status of this Factor. One of `unverified` or `verified`. new_factor_enum_factor_types: type: string enum: - push - totp description: The Type of this Factor. Currently `push` and `totp` are supported. new_factor_enum_notification_platforms: type: string enum: - apn - fcm - none new_factor_enum_totp_algorithms: type: string enum: - sha1 - sha256 - sha512 verify.v2.service.entity.challenge.notification: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^NT[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this Notification. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Account. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Service. entity_sid: type: string minLength: 34 maxLength: 34 pattern: ^YE[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Entity. identity: type: string nullable: true description: Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. x-twilio: pii: handling: standard deleteSla: 30 challenge_sid: type: string minLength: 34 maxLength: 34 pattern: ^YC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Challenge. priority: type: string nullable: true description: The priority of the notification. For `push` Challenges it's always `high` which sends the notification immediately, and can wake up a sleeping device. ttl: type: integer default: 0 description: 'How long, in seconds, the notification is valid. Max: 5 minutes' date_created: type: string format: date-time nullable: true description: The date that this Notification was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. verify.v2.service.rate_limit: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this Rate Limit. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Rate Limit resource. unique_name: type: string nullable: true description: Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. **This value should not contain PII.** description: type: string nullable: true description: Description of this Rate Limit date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. url: type: string format: uri nullable: true description: The URL of this resource. links: type: object format: uri-map nullable: true description: The URLs of related resources. verify.v2.safelist: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^GN[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the SafeList resource. phone_number: type: string nullable: true description: The phone number in SafeList. x-twilio: pii: handling: standard deleteSla: 0 url: type: string format: uri nullable: true description: The absolute URL of the SafeList resource. verify.v2.service: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Service resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource. friendly_name: type: string nullable: true description: The name that appears in the body of your verification messages. It can be up to 30 characters long and can include letters, numbers, spaces, dashes, underscores. Phone numbers, special characters or links are NOT allowed. It cannot contain more than 4 (consecutive or non-consecutive) digits. **This value should not contain PII.** code_length: type: integer default: 0 description: The length of the verification code to generate. lookup_enabled: type: boolean nullable: true description: Whether to perform a lookup with each verification started and return info about the phone number. psd2_enabled: type: boolean nullable: true description: Whether to pass PSD2 transaction parameters when starting a verification. skip_sms_to_landlines: type: boolean nullable: true description: Whether to skip sending SMS verifications to landlines. Requires `lookup_enabled`. dtmf_input_required: type: boolean nullable: true description: Whether to ask the user to press a number before delivering the verify code in a phone call. tts_name: type: string nullable: true description: The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages. do_not_share_warning_enabled: type: boolean nullable: true description: "Whether to add a security warning at the end of an SMS verification\ \ body. Disabled by default and applies only to SMS. Example SMS body:\ \ `Your AppName verification code is: 1234. Don\u2019t share this code\ \ with anyone; our employees will never ask for the code`" custom_code_enabled: type: boolean nullable: true description: Whether to allow sending verifications with a custom code instead of a randomly generated one. push: nullable: true description: Configurations for the Push factors (channel) created under this Service. totp: nullable: true description: Configurations for the TOTP factors (channel) created under this Service. default_template_sid: type: string minLength: 34 maxLength: 34 pattern: ^HJ[0-9a-fA-F]{32}$ nullable: true whatsapp: nullable: true verify_event_subscription_enabled: type: boolean nullable: true description: Whether to allow verifications from the service to reach the stream-events sinks if configured date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. url: type: string format: uri nullable: true description: The absolute URL of the resource. links: type: object format: uri-map nullable: true description: The URLs of related resources. verify.v2.service.verification: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^VE[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Verification resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Verification resource. to: type: string nullable: true description: The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). x-twilio: pii: handling: standard deleteSla: 30 channel: $ref: '#/components/schemas/verification_enum_channel' status: type: string nullable: true description: 'The status of the verification. Can be: `pending`, `approved`, `canceled`, `max_attempts_reached`, `deleted`, `failed` or `expired`.' valid: type: boolean nullable: true description: Use "status" instead. Legacy property indicating whether the verification was successful. lookup: nullable: true description: Information about the phone number being verified. amount: type: string nullable: true description: The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. x-twilio: pii: handling: sensitive deleteSla: 1 payee: type: string nullable: true description: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. x-twilio: pii: handling: sensitive deleteSla: 1 send_code_attempts: type: array items: {} nullable: true description: An array of verification attempt objects containing the channel attempted and the channel-specific transaction SID. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. sna: nullable: true description: The set of fields used for a silent network auth (`sna`) verification. Contains a single field with the URL to be invoked to verify the phone number. url: type: string format: uri nullable: true description: The absolute URL of the Verification resource. verification_enum_channel: type: string enum: - sms - call - email - whatsapp - sna description: 'The verification method used. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, `sna`, or `rcs`.' verification_enum_status: type: string enum: - canceled - approved description: 'The status of the verification. Can be: `pending`, `approved`, `canceled`, `max_attempts_reached`, `deleted`, `failed` or `expired`.' verification_enum_risk_check: type: string enum: - enable - disable verify.v2.verification_attempt: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^VL[0-9a-fA-F]{32}$ nullable: true description: The SID that uniquely identifies the verification attempt resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Verification resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) used to generate the attempt. verification_sid: type: string minLength: 34 maxLength: 34 pattern: ^VE[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Verification](https://www.twilio.com/docs/verify/api/verification) that generated the attempt. date_created: type: string format: date-time nullable: true description: The date that this Attempt was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date that this Attempt was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. conversion_status: $ref: '#/components/schemas/verification_attempt_enum_conversion_status' channel: $ref: '#/components/schemas/verification_attempt_enum_channels' price: nullable: true description: An object containing the charge for this verification attempt related to the channel costs and the currency used. The costs related to the succeeded verifications are not included. May not be immediately available. More information on pricing is available [here](https://www.twilio.com/en-us/verify/pricing). channel_data: nullable: true description: An object containing the channel specific information for an attempt. url: type: string format: uri nullable: true verification_attempt_enum_channels: type: string enum: - sms - call - email - whatsapp - rbm description: A string specifying the communication channel used for the verification attempt. verification_attempt_enum_call_status: type: string enum: - queued - in-progress - completed - busy - failed - no-answer - ringing - canceled verification_attempt_enum_message_status: type: string enum: - queued - sending - sent - failed - delivered - undelivered - receiving - received - accepted - scheduled - read - partially_delivered - canceled verification_attempt_enum_conversion_status: type: string enum: - converted - unconverted description: A string specifying the conversion status of the verification. A conversion happens when the user is able to provide the correct code. Possible values are `CONVERTED` and `UNCONVERTED`. verification_attempt_enum_attempt_status: type: string enum: - confirmed - unconfirmed - expired verify.v2.verification_attempts_summary: type: object properties: total_attempts: type: integer default: 0 description: Total of attempts made according to the provided filters total_converted: type: integer default: 0 description: Total of attempts made that were confirmed by the end user, according to the provided filters. total_unconverted: type: integer default: 0 description: Total of attempts made that were not confirmed by the end user, according to the provided filters. conversion_rate_percentage: type: string nullable: true description: 'Percentage of the confirmed messages over the total, defined by (total_converted/total_attempts)*100. ' url: type: string format: uri nullable: true verification_attempts_summary_enum_channels: type: string enum: - sms - call - email - whatsapp - rbm verify.v2.service.verification_check: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^VE[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the VerificationCheck resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the VerificationCheck resource. to: type: string nullable: true description: The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). x-twilio: pii: handling: standard deleteSla: 30 channel: $ref: '#/components/schemas/verification_check_enum_channel' status: type: string nullable: true description: 'The status of the verification. Can be: `pending`, `approved`, `canceled`, `max_attempts_reached`, `deleted`, `failed` or `expired`.' valid: type: boolean nullable: true description: Use "status" instead. Legacy property indicating whether the verification was successful. amount: type: string nullable: true description: The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. x-twilio: pii: handling: sensitive deleteSla: 1 payee: type: string nullable: true description: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. x-twilio: pii: handling: sensitive deleteSla: 1 date_created: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the Verification Check resource was created. date_updated: type: string format: date-time nullable: true description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the Verification Check resource was last updated. sna_attempts_error_codes: type: array items: {} nullable: true description: List of error codes as a result of attempting a verification using the `sna` channel. The error codes are chronologically ordered, from the first attempt to the latest attempt. This will be an empty list if no errors occured or `null` if the last channel used wasn't `sna`. verification_check_enum_channel: type: string enum: - sms - call - email - whatsapp - sna description: 'The verification method to use. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, or `sna`.' verify.v2.verification_template: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^HJ[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies a Verification Template. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Account. friendly_name: type: string nullable: true description: A descriptive string that you create to describe a Template. It can be up to 32 characters long. channels: type: array items: type: string nullable: true description: 'A list of channels that support the Template. Can include: sms, voice.' translations: nullable: true description: An object that contains the different translations of the template. Every translation is identified by the language short name and contains its respective information as the approval status, text and created/modified date. verify.v2.service.webhook: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^YW[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Webhook resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Service. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the webhook. **This value should not contain PII.** event_types: type: array items: type: string nullable: true description: 'The array of events that this Webhook is subscribed to. Possible event types: `*, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied`' status: $ref: '#/components/schemas/webhook_enum_status' version: $ref: '#/components/schemas/webhook_enum_version' webhook_url: type: string format: uri nullable: true description: The URL associated with this Webhook. webhook_method: $ref: '#/components/schemas/webhook_enum_methods' date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Webhook resource. webhook_enum_status: type: string enum: - enabled - disabled description: 'The webhook status. Default value is `enabled`. One of: `enabled` or `disabled`' webhook_enum_version: type: string enum: - v1 - v2 description: The webhook version. Default value is `v2` which includes all the latest fields. Version `v1` is legacy and may be removed in the future. webhook_enum_methods: type: string enum: - GET - POST description: The method to be used when calling the webhook's URL. info: title: Twilio - Verify description: This is the public Twilio REST API. termsOfService: https://www.twilio.com/legal/tos contact: name: Twilio Support url: https://support.twilio.com email: support@twilio.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: 1.0.0 openapi: 3.0.1 paths: /v2/Services/{ServiceSid}/AccessTokens: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - account_sid - service_sid - entity_identity - factor_type - factor_friendly_name - token - ttl - date_created parent: /Services/{Sid} pathType: list post: description: Create a new enrollment Access Token for the Entity summary: Create a new enrollment Access Token for the Entity tags: - VerifyV2AccessToken parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.access_token' examples: createWithTtl: value: sid: YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_identity: ff483d1ff591898a9942916050d2ca3f factor_type: push factor_friendly_name: John Doe iPhone ttl: 300 date_created: '2015-07-30T20:00:00Z' token: eyJ6aXAiOiJERUYiLCJraWQiOiJTQVNfUzNfX19LTVNfdjEiLCJjdHkiOiJ0d2lsaW8tZnBhO3Y9MSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJkaXIifQ..qjltWfIgQaTwp2De.81Z_6W4kR-hdlAUvJQCbwS8CQ7QAoFRkOvNMoySEj8zEB4BAY3MXhPARfaK4Lnr4YceA2cXEmrzPKQ7bPm0XZMGYm1fqLYzAR8YAqUetI9WEdQLFytg1h4XnJnXhgd99eNXsLkpKHhsCnFkchV9eGpRrdrfB0STR5Xq0fdakomb98iuIFt1XtP0_iqxvxQZKe1O4035XhK_ELVwQBz_qdI77XRZBFM0REAzlnEOe61nOcQxkaIM9Qel9L7RPhcndcCPFAyYjxo6Ri5c4vOnszLDiHmeK9Ep9fRE5-Oz0px0ZEg_FgTUEPFPo2OHQj076H1plJnFr-qPINDJkUL_i7loqG1IlapOi1JSlflPH-Ebj4hhpBdMIcs-OX7jhqzmVqkIKWkpPyPEmfvY2-eA5Zpoo08YpqAJ3G1l_xEcHl28Ijkefj1mdb6E8POx41skAwXCpdfIbzWzV_VjFpmwhacS3JZNt9C4hVG4Yp-RGPEl1C7aJHRIUavAmoRHaXbfG20zzv5Zu0P5PcopDszzoqVfZpzc.GCt35DWTurtP-QaIL5aBSQ url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens/YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createWithoutTtl: value: sid: YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_identity: ff483d1ff591898a9942916050d2ca3f factor_type: push factor_friendly_name: John Doe iPhone ttl: 60 date_created: '2015-07-30T20:00:00Z' token: eyJ6aXAiOiJERUYiLCJraWQiOiJTQVNfUzNfX19LTVNfdjEiLCJjdHkiOiJ0d2lsaW8tZnBhO3Y9MSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJkaXIifQ..qjltWfIgQaTwp2De.81Z_6W4kR-hdlAUvJQCbwS8CQ7QAoFRkOvNMoySEj8zEB4BAY3MXhPARfaK4Lnr4YceA2cXEmrzPKQ7bPm0XZMGYm1fqLYzAR8YAqUetI9WEdQLFytg1h4XnJnXhgd99eNXsLkpKHhsCnFkchV9eGpRrdrfB0STR5Xq0fdakomb98iuIFt1XtP0_iqxvxQZKe1O4035XhK_ELVwQBz_qdI77XRZBFM0REAzlnEOe61nOcQxkaIM9Qel9L7RPhcndcCPFAyYjxo6Ri5c4vOnszLDiHmeK9Ep9fRE5-Oz0px0ZEg_FgTUEPFPo2OHQj076H1plJnFr-qPINDJkUL_i7loqG1IlapOi1JSlflPH-Ebj4hhpBdMIcs-OX7jhqzmVqkIKWkpPyPEmfvY2-eA5Zpoo08YpqAJ3G1l_xEcHl28Ijkefj1mdb6E8POx41skAwXCpdfIbzWzV_VjFpmwhacS3JZNt9C4hVG4Yp-RGPEl1C7aJHRIUavAmoRHaXbfG20zzv5Zu0P5PcopDszzoqVfZpzc.GCt35DWTurtP-QaIL5aBSQ url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens/YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.access_token' examples: createWithTtl200: value: sid: YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_identity: ff483d1ff591898a9942916050d2ca3f factor_type: push factor_friendly_name: John Doe iPhone ttl: 300 date_created: '2015-07-30T20:00:00Z' token: eyJ6aXAiOiJERUYiLCJraWQiOiJTQVNfUzNfX19LTVNfdjEiLCJjdHkiOiJ0d2lsaW8tZnBhO3Y9MSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJkaXIifQ..qjltWfIgQaTwp2De.81Z_6W4kR-hdlAUvJQCbwS8CQ7QAoFRkOvNMoySEj8zEB4BAY3MXhPARfaK4Lnr4YceA2cXEmrzPKQ7bPm0XZMGYm1fqLYzAR8YAqUetI9WEdQLFytg1h4XnJnXhgd99eNXsLkpKHhsCnFkchV9eGpRrdrfB0STR5Xq0fdakomb98iuIFt1XtP0_iqxvxQZKe1O4035XhK_ELVwQBz_qdI77XRZBFM0REAzlnEOe61nOcQxkaIM9Qel9L7RPhcndcCPFAyYjxo6Ri5c4vOnszLDiHmeK9Ep9fRE5-Oz0px0ZEg_FgTUEPFPo2OHQj076H1plJnFr-qPINDJkUL_i7loqG1IlapOi1JSlflPH-Ebj4hhpBdMIcs-OX7jhqzmVqkIKWkpPyPEmfvY2-eA5Zpoo08YpqAJ3G1l_xEcHl28Ijkefj1mdb6E8POx41skAwXCpdfIbzWzV_VjFpmwhacS3JZNt9C4hVG4Yp-RGPEl1C7aJHRIUavAmoRHaXbfG20zzv5Zu0P5PcopDszzoqVfZpzc.GCt35DWTurtP-QaIL5aBSQ url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens/YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: CreateAccessToken requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateAccessTokenRequest properties: Identity: type: string description: The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, and generated by your external system, such as your user's UUID, GUID, or SID. FactorType: $ref: '#/components/schemas/access_token_enum_factor_types' FactorFriendlyName: type: string description: The friendly name of the factor that is going to be created with this access token Ttl: type: integer description: How long, in seconds, the access token is valid. Can be an integer between 60 and 300. Default is 60. required: - Identity - FactorType examples: createWithTtl: value: FactorType: push FactorFriendlyName: John Doe iPhone Identity: ff483d1ff591898a9942916050d2ca3f Ttl: 300 createWithTtl200: value: FactorType: push FactorFriendlyName: John Doe iPhone Identity: ff483d1ff591898a9942916050d2ca3f Ttl: 300 createWithoutTtl: value: FactorType: push FactorFriendlyName: John Doe iPhone Identity: ff483d1ff591898a9942916050d2ca3f /v2/Services/{ServiceSid}/AccessTokens/{Sid}: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - account_sid - service_sid - entity_identity - factor_type - factor_friendly_name - token - ttl - date_created parent: /Services/{Sid} pathType: instance get: description: Fetch an Access Token for the Entity summary: Fetch an Access Token for the Entity tags: - VerifyV2AccessToken parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Access Token. schema: type: string minLength: 34 maxLength: 34 pattern: ^YK[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.access_token' examples: fetch: value: sid: YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_identity: ff483d1ff591898a9942916050d2ca3f factor_type: push factor_friendly_name: John Doe iPhone ttl: 60 date_created: '2015-07-30T20:00:00Z' token: eyJ6aXAiOiJERUYiLCJraWQiOiJTQVNfUzNfX19LTVNfdjEiLCJjdHkiOiJ0d2lsaW8tZnBhO3Y9MSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJkaXIifQ..qjltWfIgQaTwp2De.81Z_6W4kR-hdlAUvJQCbwS8CQ7QAoFRkOvNMoySEj8zEB4BAY3MXhPARfaK4Lnr4YceA2cXEmrzPKQ7bPm0XZMGYm1fqLYzAR8YAqUetI9WEdQLFytg1h4XnJnXhgd99eNXsLkpKHhsCnFkchV9eGpRrdrfB0STR5Xq0fdakomb98iuIFt1XtP0_iqxvxQZKe1O4035XhK_ELVwQBz_qdI77XRZBFM0REAzlnEOe61nOcQxkaIM9Qel9L7RPhcndcCPFAyYjxo6Ri5c4vOnszLDiHmeK9Ep9fRE5-Oz0px0ZEg_FgTUEPFPo2OHQj076H1plJnFr-qPINDJkUL_i7loqG1IlapOi1JSlflPH-Ebj4hhpBdMIcs-OX7jhqzmVqkIKWkpPyPEmfvY2-eA5Zpoo08YpqAJ3G1l_xEcHl28Ijkefj1mdb6E8POx41skAwXCpdfIbzWzV_VjFpmwhacS3JZNt9C4hVG4Yp-RGPEl1C7aJHRIUavAmoRHaXbfG20zzv5Zu0P5PcopDszzoqVfZpzc.GCt35DWTurtP-QaIL5aBSQ url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens/YKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchAccessToken /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - service_sid - rate_limit_sid - account_sid - max - interval - date_created - date_updated parent: /Services/{ServiceSid}/RateLimits/{Sid} pathType: list post: description: Create a new Bucket for a Rate Limit summary: Create a new Bucket for a Rate Limit tags: - VerifyV2Bucket parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: RateLimitSid in: path description: The Twilio-provided string that uniquely identifies the Rate Limit resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit.bucket' examples: createBucket: value: sid: BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa rate_limit_sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa max: 5 interval: 60 date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateBucket requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateBucketRequest properties: Max: type: integer description: Maximum number of requests permitted in during the interval. Interval: type: integer description: Number of seconds that the rate limit will be enforced over. required: - Max - Interval examples: createBucket: value: Max: 5 Interval: 60 get: description: Retrieve a list of all Buckets for a Rate Limit. summary: Retrieve a list of all Buckets for a Rate Limit. tags: - VerifyV2Bucket parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: RateLimitSid in: path description: The Twilio-provided string that uniquely identifies the Rate Limit resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: buckets: type: array items: $ref: '#/components/schemas/verify.v2.service.rate_limit.bucket' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListBucketResponse examples: readEmpty: value: buckets: [] meta: page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0 previous_page_url: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0 next_page_url: null key: buckets readFull: value: buckets: - sid: BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa rate_limit_sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa max: 5 interval: 60 date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0 previous_page_url: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0 next_page_url: null key: buckets headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListBucket /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets/{Sid}: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - service_sid - rate_limit_sid - account_sid - max - interval - date_created - date_updated parent: /Services/{ServiceSid}/RateLimits/{Sid} pathType: instance post: description: Update a specific Bucket. summary: Update a specific Bucket. tags: - VerifyV2Bucket parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: RateLimitSid in: path description: The Twilio-provided string that uniquely identifies the Rate Limit resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Bucket. schema: type: string minLength: 34 maxLength: 34 pattern: ^BL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit.bucket' examples: updateBucket: value: sid: BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa rate_limit_sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa max: 5 interval: 60 date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateBucket requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateBucketRequest properties: Max: type: integer description: Maximum number of requests permitted in during the interval. Interval: type: integer description: Number of seconds that the rate limit will be enforced over. examples: updateBucket: value: Max: 5 Interval: 60 get: description: Fetch a specific Bucket. summary: Fetch a specific Bucket. tags: - VerifyV2Bucket parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: RateLimitSid in: path description: The Twilio-provided string that uniquely identifies the Rate Limit resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Bucket. schema: type: string minLength: 34 maxLength: 34 pattern: ^BL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit.bucket' examples: fetchBucket: value: sid: BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa rate_limit_sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa max: 5 interval: 60 date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchBucket delete: description: Delete a specific Bucket. summary: Delete a specific Bucket. tags: - VerifyV2Bucket parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: RateLimitSid in: path description: The Twilio-provided string that uniquely identifies the Rate Limit resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Bucket. schema: type: string minLength: 34 maxLength: 34 pattern: ^BL[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteBucket /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - factor_type - status - responded_reason - date_created dependentProperties: notifications: mapping: service_sid: service_sid identity: identity challenge_sid: sid resource_url: /v2/Services/{service_sid}/Entities/{identity}/Challenges/{challenge_sid}/Notifications parent: /Services/{ServiceSid}/Entities/{Identity} pathType: list post: description: Create a new Challenge for the Factor summary: Create a new Challenge for the Factor tags: - VerifyV2Challenge parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.challenge' examples: createPush: value: sid: YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f factor_sid: YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' date_responded: '2015-07-30T20:00:00Z' expiration_date: '2015-07-30T20:00:00Z' status: pending responded_reason: none details: message: Hi! Mr. John Doe, would you like to sign up? date: '2020-07-01T12:13:14Z' fields: - label: Action value: Sign up in portal hidden_details: ip: 172.168.1.234 metadata: null factor_type: push url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications createTotpWithoutAuthPayload: value: sid: YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f factor_sid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' date_responded: '2015-07-30T20:00:00Z' expiration_date: '2015-07-30T20:00:00Z' status: pending responded_reason: none details: message: Hi! Mr. John Doe, would you like to sign up? date: '2020-07-01T12:13:14Z' fields: - label: Action value: Sign up in portal hidden_details: ip: 172.168.1.234 metadata: null factor_type: totp url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications createTotpWithAuthPayload: value: sid: YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f factor_sid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' date_responded: '2015-07-30T20:00:00Z' expiration_date: '2015-07-30T20:00:00Z' status: approved responded_reason: none details: message: Hi! Mr. John Doe, would you like to sign up? date: '2020-07-01T12:13:14Z' fields: - label: Action value: Sign up in portal hidden_details: ip: 172.168.1.234 metadata: null factor_type: totp url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateChallenge requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateChallengeRequest properties: FactorSid: type: string minLength: 34 maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ description: The unique SID identifier of the Factor. ExpirationDate: type: string format: date-time description: The date-time when this Challenge expires, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The default value is five (5) minutes after Challenge creation. The max value is sixty (60) minutes after creation. Details.Message: type: string description: Shown to the user when the push notification arrives. Required when `factor_type` is `push`. Can be up to 256 characters in length Details.Fields: type: array items: {} description: A list of objects that describe the Fields included in the Challenge. Each object contains the label and value of the field, the label can be up to 36 characters in length and the value can be up to 128 characters in length. Used when `factor_type` is `push`. There can be up to 20 details fields. HiddenDetails: description: 'Details provided to give context about the Challenge. Not shown to the end user. It must be a stringified JSON with only strings values eg. `{"ip": "172.168.1.234"}`. Can be up to 1024 characters in length' AuthPayload: type: string description: Optional payload used to verify the Challenge upon creation. Only used with a Factor of type `totp` to carry the TOTP code that needs to be verified. For `TOTP` this value must be between 3 and 8 characters long. required: - FactorSid examples: createPush: value: FactorSid: YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ExpirationDate: '2015-07-30T20:00:00Z' Details.Message: Hi! Mr. John Doe, would you like to sign up? Details.Fields: - '{"label": "Action", "value": "Sign up in portal"}' HiddenDetails: '{"ip": "172.168.1.234"}' createTotpWithoutAuthPayload: value: FactorSid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ExpirationDate: '2015-07-30T20:00:00Z' Details.Message: Hi! Mr. John Doe, would you like to sign up? Details.Fields: - '{"label": "Action", "value": "Sign up in portal"}' HiddenDetails: '{"ip": "172.168.1.234"}' createTotpWithAuthPayload: value: FactorSid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ExpirationDate: '2015-07-30T20:00:00Z' Details.Message: Hi! Mr. John Doe, would you like to sign up? Details.Fields: - '{"label": "Action", "value": "Sign up in portal"}' HiddenDetails: '{"ip": "172.168.1.234"}' AuthPayload: '12345678' get: description: Retrieve a list of all Challenges for a Factor. summary: Retrieve a list of all Challenges for a Factor. tags: - VerifyV2Challenge parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: FactorSid in: query description: The unique SID identifier of the Factor. schema: type: string minLength: 34 maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ - name: Status in: query description: The Status of the Challenges to fetch. One of `pending`, `expired`, `approved` or `denied`. schema: $ref: '#/components/schemas/challenge_enum_challenge_statuses' - name: Order in: query description: The desired sort order of the Challenges list. One of `asc` or `desc` for ascending and descending respectively. Defaults to `asc`. schema: $ref: '#/components/schemas/challenge_enum_list_orders' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: challenges: type: array items: $ref: '#/components/schemas/verify.v2.service.entity.challenge' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListChallengeResponse examples: readEmpty: value: challenges: [] meta: page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0 previous_page_url: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0 next_page_url: null key: challenges readFull: value: challenges: - sid: YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f factor_sid: YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' date_responded: '2015-07-30T20:00:00Z' expiration_date: '2015-07-30T20:00:00Z' status: pending responded_reason: none details: message: Hi! Mr. John Doe, would you like to sign up? date: '2020-07-01T12:13:14Z' fields: - label: Action value: Sign up in portal hidden_details: ip: 172.168.1.234 metadata: null factor_type: push url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications - sid: YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f factor_sid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' date_responded: '2015-07-30T20:00:00Z' expiration_date: '2015-07-30T20:00:00Z' status: pending responded_reason: none details: message: Hi! Mr. John Doe, would you like to sign up? date: '2020-07-01T12:13:14Z' fields: - label: Action value: Sign up in portal hidden_details: ip: 172.168.1.234 metadata: null factor_type: totp url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications meta: page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0 previous_page_url: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges?PageSize=50&Page=0 next_page_url: null key: challenges headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListChallenge /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - factor_type - status - responded_reason - date_created dependentProperties: notifications: mapping: service_sid: service_sid identity: identity challenge_sid: sid resource_url: /v2/Services/{service_sid}/Entities/{identity}/Challenges/{challenge_sid}/Notifications parent: /Services/{ServiceSid}/Entities/{Identity} pathType: instance get: description: Fetch a specific Challenge. summary: Fetch a specific Challenge. tags: - VerifyV2Challenge parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Challenges. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Challenge. schema: type: string minLength: 34 maxLength: 34 pattern: ^YC[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.challenge' examples: fetchSid: value: sid: YCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f factor_sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' date_responded: '2015-07-30T20:00:00Z' expiration_date: '2015-07-30T20:00:00Z' status: approved responded_reason: none details: message: Hi! Mr. John Doe, would you like to sign up? date: '2020-07-01T12:13:14Z' fields: - label: Action value: Sign up in portal hidden_details: ip: 172.168.1.234 metadata: os: Android factor_type: push url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications headers: Twilio-Verify-Signature-Fields: schema: type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchChallenge post: description: Verify a specific Challenge. summary: Verify a specific Challenge. tags: - VerifyV2Challenge parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Challenge. schema: type: string minLength: 34 maxLength: 34 pattern: ^YC[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.challenge' examples: verifyPush: value: sid: YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f factor_sid: YF03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' date_responded: '2015-07-30T20:00:00Z' expiration_date: '2015-07-30T20:00:00Z' status: approved responded_reason: none details: message: Hi! Mr. John Doe, would you like to sign up? date: '2020-07-01T12:13:14Z' fields: - label: Action value: Sign up in portal hidden_details: ip: 172.168.1.234 metadata: os: Android factor_type: push url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications verifyTotp: value: sid: YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f factor_sid: YF02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' date_responded: '2015-07-30T20:00:00Z' expiration_date: '2015-07-30T20:00:00Z' status: approved responded_reason: none details: message: Hi! Mr. John Doe, would you like to sign up? date: '2020-07-01T12:13:14Z' fields: - label: Action value: Sign up in portal hidden_details: ip: 172.168.1.234 metadata: null factor_type: totp url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: notifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges/YC02aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications headers: Twilio-Verify-Challenge-Signature: schema: type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateChallenge requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateChallengeRequest properties: AuthPayload: type: string description: The optional payload needed to verify the Challenge. E.g., a TOTP would use the numeric code. For `TOTP` this value must be between 3 and 8 characters long. For `Push` this value can be up to 5456 characters in length Metadata: description: 'Custom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' examples: verifyPush: value: AuthPayload: '123456' Metadata: '{"os": "Android"}' verifyTotp: value: AuthPayload: '123456' /v2/Services/{ServiceSid}/Entities: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created dependentProperties: factors: mapping: service_sid: service_sid identity: identity resource_url: /v2/Services/{service_sid}/Entities/{identity}/Factors new_factors: mapping: service_sid: service_sid identity: identity resource_url: /v2/Services/{service_sid}/Entities/{identity}/Factors challenges: mapping: service_sid: service_sid identity: identity resource_url: /v2/Services/{service_sid}/Entities/{identity}/Challenges parent: /Services/{Sid} pathType: list post: description: Create a new Entity for the Service summary: Create a new Entity for the Service tags: - VerifyV2Entity parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity' examples: create: value: sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f links: factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors new_factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors challenges: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateEntity requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateEntityRequest properties: Identity: type: string description: The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. required: - Identity examples: create: value: Identity: ff483d1ff591898a9942916050d2ca3f get: description: Retrieve a list of all Entities for a Service. summary: Retrieve a list of all Entities for a Service. tags: - VerifyV2Entity parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: entities: type: array items: $ref: '#/components/schemas/verify.v2.service.entity' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListEntityResponse examples: readEmpty: value: entities: [] meta: page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0 previous_page_url: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0 next_page_url: null key: entities readFull: value: entities: - sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f links: factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors new_factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors challenges: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges meta: page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0 previous_page_url: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities?PageSize=50&Page=0 next_page_url: null key: entities headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListEntity /v2/Services/{ServiceSid}/Entities/{Identity}: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - identity - date_created dependentProperties: factors: mapping: service_sid: service_sid identity: identity resource_url: /v2/Services/{service_sid}/Entities/{identity}/Factors new_factors: mapping: service_sid: service_sid identity: identity resource_url: /v2/Services/{service_sid}/Entities/{identity}/Factors challenges: mapping: service_sid: service_sid identity: identity resource_url: /v2/Services/{service_sid}/Entities/{identity}/Challenges parent: /Services/{Sid} pathType: instance delete: description: Delete a specific Entity. summary: Delete a specific Entity. tags: - VerifyV2Entity parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteEntity get: description: Fetch a specific Entity. summary: Fetch a specific Entity. tags: - VerifyV2Entity parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity' examples: fetch: value: sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f links: factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors new_factors: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors challenges: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Challenges headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchEntity /v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - status - factor_type parent: /Services/{ServiceSid}/Entities/{Identity} pathType: instance delete: description: Delete a specific Factor. summary: Delete a specific Factor. tags: - VerifyV2Factor parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Factor. schema: type: string minLength: 34 maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteFactor get: description: Fetch a specific Factor. summary: Fetch a specific Factor. tags: - VerifyV2Factor parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Factor. schema: type: string minLength: 34 maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.factor' examples: fetchPush: value: sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' friendly_name: friendly_name status: unverified factor_type: push config: sdk_version: '1.0' app_id: com.example.myapp notification_platform: fcm notification_token: test_token metadata: os: Android url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fetchTotp: value: sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' friendly_name: friendly_name status: unverified factor_type: totp config: alg: sha1 skew: 1 code_length: 6 time_step: 30 metadata: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchFactor post: description: Update a specific Factor. This endpoint can be used to Verify a Factor if passed an `AuthPayload` param. summary: Update a specific Factor. This endpoint can be used to Verify a Factor if passed an `AuthPayload` param. tags: - VerifyV2Factor parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: Sid in: path description: A 34 character string that uniquely identifies this Factor. schema: type: string minLength: 34 maxLength: 34 pattern: ^YF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.factor' examples: verifyPush: value: sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' friendly_name: friendly_name status: verified factor_type: push config: sdk_version: '1.0' app_id: com.example.myapp notification_platform: fcm notification_token: test_token metadata: os: Android url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa verifyTotp: value: sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' friendly_name: friendly_name status: verified factor_type: totp config: alg: sha1 skew: 1 code_length: 6 time_step: 30 metadata: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Twilio-Verify-Factor-Signature: schema: type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateFactor requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateFactorRequest properties: AuthPayload: type: string description: The optional payload needed to verify the Factor for the first time. E.g. for a TOTP, the numeric code. FriendlyName: type: string description: The new friendly name of this Factor. It can be up to 64 characters. Config.NotificationToken: type: string description: For APN, the device token. For FCM, the registration token. It is used to send the push notifications. Required when `factor_type` is `push`. If specified, this value must be between 32 and 255 characters long. Config.SdkVersion: type: string description: The Verify Push SDK version used to configure the factor Config.TimeStep: type: integer description: Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive Config.Skew: type: integer description: The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive Config.CodeLength: type: integer description: Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive Config.Alg: $ref: '#/components/schemas/factor_enum_totp_algorithms' Config.NotificationPlatform: type: string description: 'The transport technology used to generate the Notification Token. Can be `apn`, `fcm` or `none`. Required when `factor_type` is `push`.' examples: verifyPush: value: AuthPayload: '123456' FriendlyName: FriendlyName Config.SdkVersion: '1.0' Config.NotificationToken: test_token verifyTotp: value: FriendlyName: My Friendly Name AuthPayload: '123456' /v2/Services/{ServiceSid}/Entities/{Identity}/Factors: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - status - factor_type parent: /Services/{ServiceSid}/Entities/{Identity} pathType: list get: description: Retrieve a list of all Factors for an Entity. summary: Retrieve a list of all Factors for an Entity. tags: - VerifyV2Factor parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Factors. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: factors: type: array items: $ref: '#/components/schemas/verify.v2.service.entity.factor' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListFactorResponse examples: readEmpty: value: factors: [] meta: page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 previous_page_url: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 next_page_url: null key: factors readFullPush: value: factors: - sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' friendly_name: friendly_name status: unverified factor_type: push config: sdk_version: '1.0' app_id: com.example.myapp notification_platform: fcm notification_token: test_token metadata: os: Android url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 previous_page_url: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 next_page_url: null key: factors readFullTotp: value: factors: - sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' friendly_name: friendly_name status: unverified factor_type: totp config: alg: sha1 skew: 1 code_length: 6 time_step: 30 metadata: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 previous_page_url: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors?PageSize=50&Page=0 next_page_url: null key: factors readFullTotpUppercasing: value: factors: - sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: DD6840aec40ad01ebc2001c0330000aa33 date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' friendly_name: friendly_name status: unverified factor_type: totp config: alg: sha1 skew: 1 code_length: 6 time_step: 30 metadata: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/DD6840aec40ad01ebc2001c0330000aa33/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Services/VA40c58700bf85d3178ad2ae85b8d52d64/Entities/dd6840aec40ad01ebc2001c0330000aa33/Factors?PageSize=50&Page=0 previous_page_url: null url: https://verify.twilio.com/v2/Services/VA40c58700bf85d3178ad2ae85b8d52d64/Entities/dd6840aec40ad01ebc2001c0330000aa33/Factors?PageSize=50&Page=0 next_page_url: null key: factors headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListFactor post: description: Create a new Factor for the Entity summary: Create a new Factor for the Entity tags: - VerifyV2NewFactor parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.new_factor' examples: createPush: value: sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f binding: alg: ES256 public_key: MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8GdwtibWe0kpgsFl6xPQBwhtwUEyeJkeozFmi2jiJDzxFSMwVy3kVR1h/dPVYOfgkC0EkfBRJ0J/6xW47FD5vA== date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' friendly_name: friendly_name status: unverified factor_type: push config: sdk_version: '1.0' app_id: com.example.myapp notification_platform: fcm notification_token: test_token metadata: os: Android url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createTotp: value: sid: YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f binding: secret: GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ uri: otpauth://totp/test-issuer:John%E2%80%99s%20Account%20Name?secret=GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ&issuer=test-issuer&algorithm=SHA1&digits=6&period=30 date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' friendly_name: friendly_name status: unverified factor_type: totp config: alg: sha1 skew: 1 code_length: 6 time_step: 30 metadata: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities/ff483d1ff591898a9942916050d2ca3f/Factors/YFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateNewFactor requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateNewFactorRequest properties: FriendlyName: type: string description: "The friendly name of this Factor. This can be any\ \ string up to 64 characters, meant for humans to distinguish\ \ between Factors.\nFor `factor_type` `push`, this could be a\ \ device name.\nFor `factor_type` `totp`, this value is used as\ \ the \u201Caccount name\u201D in constructing the `binding.uri`\ \ property.\nAt the same time, we recommend avoiding providing\ \ PII." FactorType: $ref: '#/components/schemas/new_factor_enum_factor_types' Binding.Alg: type: string description: 'The algorithm used when `factor_type` is `push`. Algorithm supported: `ES256`' Binding.PublicKey: type: string description: 'The Ecdsa public key in PKIX, ASN.1 DER format encoded in Base64. Required when `factor_type` is `push`' Config.AppId: type: string description: 'The ID that uniquely identifies your app in the Google or Apple store, such as `com.example.myapp`. It can be up to 100 characters long. Required when `factor_type` is `push`.' Config.NotificationPlatform: $ref: '#/components/schemas/new_factor_enum_notification_platforms' Config.NotificationToken: type: string description: 'For APN, the device token. For FCM, the registration token. It is used to send the push notifications. Must be between 32 and 255 characters long. Required when `factor_type` is `push`.' Config.SdkVersion: type: string description: 'The Verify Push SDK version used to configure the factor Required when `factor_type` is `push`' Binding.Secret: type: string description: 'The shared secret for TOTP factors encoded in Base32. This can be provided when creating the Factor, otherwise it will be generated. Used when `factor_type` is `totp`' Config.TimeStep: type: integer description: 'Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive. The default value is defined at the service level in the property `totp.time_step`. Defaults to 30 seconds if not configured. Used when `factor_type` is `totp`' Config.Skew: type: integer description: 'The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. The default value is defined at the service level in the property `totp.skew`. If not configured defaults to 1. Used when `factor_type` is `totp`' Config.CodeLength: type: integer description: 'Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive. The default value is defined at the service level in the property `totp.code_length`. If not configured defaults to 6. Used when `factor_type` is `totp`' Config.Alg: $ref: '#/components/schemas/new_factor_enum_totp_algorithms' Metadata: description: 'Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' required: - FriendlyName - FactorType examples: createPush: value: FactorType: push FriendlyName: FriendlyName Binding.Alg: ES256 Binding.PublicKey: dGVzdF9rZXk= Config.SdkVersion: '1.0' Config.AppId: com.example.myapp Config.NotificationPlatform: fcm Config.NotificationToken: test_token Metadata: '{"os": "Android"}' createTotp: value: FactorType: totp FriendlyName: FriendlyName Binding.Secret: GEZDGNBVGY3TQOJQGEZDGNBVGY3TQOJQ Config.Alg: sha1 Config.TimeStep: 30 Config.CodeLength: 6 Config.Skew: 1 x-twilio: mountName: new_factors /v2/Forms/{FormType}: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - form_type pathType: instance get: description: Fetch the forms for a specific Form Type. summary: Fetch the forms for a specific Form Type. tags: - VerifyV2Form parameters: - name: FormType in: path description: The Type of this Form. Currently only `form-push` is supported. schema: $ref: '#/components/schemas/form_enum_form_types' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.form' examples: fetch: value: form_type: form-push forms: create_factor: {} verify_factor: {} create_challenge: {} form_meta: {} url: https://verify.twilio.com/v2/Forms/form-push headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchForm /v2/Services/{ServiceSid}/MessagingConfigurations: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - account_sid - service_sid - country - messaging_service_sid - date_created - date_updated parent: /Services/{Sid} pathType: list post: description: Create a new MessagingConfiguration for a service. summary: Create a new MessagingConfiguration for a service. tags: - VerifyV2MessagingConfiguration parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.messaging_configuration' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa country: CA messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateMessagingConfiguration requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateMessagingConfigurationRequest properties: Country: type: string description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`. MessagingServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration. required: - Country - MessagingServiceSid examples: create: value: Country: CA MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all Messaging Configurations for a Service. summary: Retrieve a list of all Messaging Configurations for a Service. tags: - VerifyV2MessagingConfiguration parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: messaging_configurations: type: array items: $ref: '#/components/schemas/verify.v2.service.messaging_configuration' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListMessagingConfigurationResponse examples: readEmpty: value: messaging_configurations: [] meta: page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0 previous_page_url: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0 next_page_url: null key: messaging_configurations readFull: value: messaging_configurations: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa country: CA messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA meta: page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0 previous_page_url: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations?PageSize=50&Page=0 next_page_url: null key: messaging_configurations headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListMessagingConfiguration /v2/Services/{ServiceSid}/MessagingConfigurations/{Country}: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - account_sid - service_sid - country - messaging_service_sid - date_created - date_updated parent: /Services/{Sid} pathType: instance post: description: Update a specific MessagingConfiguration summary: Update a specific MessagingConfiguration tags: - VerifyV2MessagingConfiguration parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Country in: path description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.messaging_configuration' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa country: CA messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateMessagingConfiguration requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateMessagingConfigurationRequest properties: MessagingServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration. required: - MessagingServiceSid examples: update: value: MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Fetch a specific MessagingConfiguration. summary: Fetch a specific MessagingConfiguration. tags: - VerifyV2MessagingConfiguration parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Country in: path description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.messaging_configuration' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa country: CA messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations/CA headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchMessagingConfiguration delete: description: Delete a specific MessagingConfiguration. summary: Delete a specific MessagingConfiguration. tags: - VerifyV2MessagingConfiguration parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Country in: path description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteMessagingConfiguration /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{ChallengeSid}/Notifications: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - identity - challenge_sid - date_created parent: /Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid} pathType: list post: description: Create a new Notification for the corresponding Challenge summary: Create a new Notification for the corresponding Challenge tags: - VerifyV2Notification parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Identity in: path description: Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 required: true - name: ChallengeSid in: path description: The unique SID identifier of the Challenge. schema: type: string minLength: 34 maxLength: 34 pattern: ^YC[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.entity.challenge.notification' examples: createWithTtl: value: sid: NTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f challenge_sid: YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' priority: high ttl: 150 createWithoutTtl: value: sid: NTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa entity_sid: YEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: ff483d1ff591898a9942916050d2ca3f challenge_sid: YC03aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' priority: high ttl: 300 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateNotification requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateNotificationRequest properties: Ttl: type: integer description: How long, in seconds, the notification is valid. Can be an integer between 0 and 300. Default is 300. Delivery is attempted until the TTL elapses, even if the device is offline. 0 means that the notification delivery is attempted immediately, only once, and is not stored for future delivery. examples: createWithTtl: value: Ttl: 150 createWithoutTtl: value: {} /v2/Services/{ServiceSid}/RateLimits: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - service_sid - account_sid - unique_name - description - date_created - date_updated dependentProperties: buckets: mapping: service_sid: service_sid rate_limit_sid: sid resource_url: /v2/Services/{service_sid}/RateLimits/{rate_limit_sid}/Buckets parent: /Services/{Sid} pathType: list post: description: Create a new Rate Limit for a Service summary: Create a new Rate Limit for a Service tags: - VerifyV2RateLimit parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit' examples: createRateLimit: value: sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique.name description: Description date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: buckets: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateRateLimit requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateRateLimitRequest properties: UniqueName: type: string description: Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. **This value should not contain PII.** Description: type: string description: Description of this Rate Limit required: - UniqueName examples: createRateLimit: value: UniqueName: unique.name Description: Description get: description: Retrieve a list of all Rate Limits for a service. summary: Retrieve a list of all Rate Limits for a service. tags: - VerifyV2RateLimit parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: rate_limits: type: array items: $ref: '#/components/schemas/verify.v2.service.rate_limit' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListRateLimitResponse examples: readAll: value: meta: page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits?PageSize=50&Page=0 previous_page_url: null next_page_url: null key: rate_limits url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits?PageSize=50&Page=0 rate_limits: - sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique.name description: Description date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: buckets: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListRateLimit /v2/Services/{ServiceSid}/RateLimits/{Sid}: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - service_sid - account_sid - unique_name - description - date_created - date_updated dependentProperties: buckets: mapping: service_sid: service_sid rate_limit_sid: sid resource_url: /v2/Services/{service_sid}/RateLimits/{rate_limit_sid}/Buckets parent: /Services/{Sid} pathType: instance post: description: Update a specific Rate Limit. summary: Update a specific Rate Limit. tags: - VerifyV2RateLimit parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Rate Limit resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit' examples: updateRateLimit: value: sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique.name description: Description date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: buckets: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateRateLimit requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateRateLimitRequest properties: Description: type: string description: Description of this Rate Limit examples: updateRateLimit: value: Description: Description get: description: Fetch a specific Rate Limit. summary: Fetch a specific Rate Limit. tags: - VerifyV2RateLimit parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Rate Limit resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.rate_limit' examples: fetchRateLimit: value: sid: RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique.name description: Description date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: buckets: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchRateLimit delete: description: Delete a specific Rate Limit. summary: Delete a specific Rate Limit. tags: - VerifyV2RateLimit parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Rate Limit resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^RK[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteRateLimit /v2/SafeList/Numbers: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - phone_number mountName: safelist pathType: list post: description: Add a new phone number to SafeList. summary: Add a new phone number to SafeList. tags: - VerifyV2Safelist responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.safelist' examples: create: value: sid: GNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa phone_number: '+18001234567' url: https://verify.twilio.com/v2/SafeList/Numbers/+18001234567 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateSafelist requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateSafelistRequest properties: PhoneNumber: type: string description: The phone number to be added in SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). required: - PhoneNumber examples: create: value: PhoneNumber: '+18001234567' /v2/SafeList/Numbers/{PhoneNumber}: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - phone_number mountName: safelist pathType: instance get: description: Check if a phone number exists in SafeList. summary: Check if a phone number exists in SafeList. tags: - VerifyV2Safelist parameters: - name: PhoneNumber in: path description: The phone number to be fetched from SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). schema: type: string x-twilio: pii: handling: standard deleteSla: 0 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.safelist' examples: fetch: value: sid: GNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa phone_number: '+18001234567' url: https://verify.twilio.com/v2/SafeList/Numbers/+18001234567 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchSafelist delete: description: Remove a phone number from SafeList. summary: Remove a phone number from SafeList. tags: - VerifyV2Safelist parameters: - name: PhoneNumber in: path description: The phone number to be removed from SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). schema: type: string x-twilio: pii: handling: standard deleteSla: 0 required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteSafelist /v2/Services: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created dependentProperties: verifications: mapping: service_sid: sid resource_url: /v2/Services/{service_sid}/Verifications verification_checks: mapping: service_sid: sid resource_url: /v2/Services/{service_sid}/VerificationCheck rate_limits: mapping: service_sid: sid resource_url: /v2/Services/{service_sid}/RateLimits messaging_configurations: mapping: service_sid: sid resource_url: /v2/Services/{service_sid}/MessagingConfigurations entities: mapping: service_sid: sid resource_url: /v2/Services/{service_sid}/Entities webhooks: mapping: service_sid: sid resource_url: /v2/Services/{service_sid}/Webhooks access_tokens: mapping: service_sid: sid resource_url: /v2/Services/{service_sid}/AccessTokens pathType: list post: description: Create a new Verification Service. summary: Create a new Verification Service. tags: - VerifyV2Service responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service' examples: createRecord: value: sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: name code_length: 4 lookup_enabled: false psd2_enabled: false skip_sms_to_landlines: false dtmf_input_required: false tts_name: name mailer_sid: MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa do_not_share_warning_enabled: false custom_code_enabled: true push: include_date: false apn_credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fcm_credential_sid: null totp: issuer: test-issuer time_step: 30 code_length: 3 skew: 2 whatsapp: msg_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa from: whatsapp:+1234567890 default_template_sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa verify_event_subscription_enabled: false date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: verification_checks: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/VerificationCheck verifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications rate_limits: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits messaging_configurations: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations entities: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities webhooks: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks access_tokens: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateService requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateServiceRequest properties: FriendlyName: type: string description: A descriptive string that you create to describe the verification service. It can be up to 32 characters long. **This value should not contain PII.** CodeLength: type: integer description: The length of the verification code to generate. Must be an integer value between 4 and 10, inclusive. LookupEnabled: type: boolean description: Whether to perform a lookup with each verification started and return info about the phone number. SkipSmsToLandlines: type: boolean description: Whether to skip sending SMS verifications to landlines. Requires `lookup_enabled`. DtmfInputRequired: type: boolean description: Whether to ask the user to press a number before delivering the verify code in a phone call. TtsName: type: string description: The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages. Psd2Enabled: type: boolean description: Whether to pass PSD2 transaction parameters when starting a verification. DoNotShareWarningEnabled: type: boolean description: "Whether to add a security warning at the end of an\ \ SMS verification body. Disabled by default and applies only\ \ to SMS. Example SMS body: `Your AppName verification code is:\ \ 1234. Don\u2019t share this code with anyone; our employees\ \ will never ask for the code`" CustomCodeEnabled: type: boolean description: Whether to allow sending verifications with a custom code instead of a randomly generated one. Push.IncludeDate: type: boolean description: "Optional configuration for the Push factors. If true,\ \ include the date in the Challenge's response. Otherwise, the\ \ date is omitted from the response. See [Challenge](https://www.twilio.com/docs/verify/api/challenge)\ \ resource\u2019s details parameter for more info. Default: false.\ \ **Deprecated** do not use this parameter. This timestamp value\ \ is the same one as the one found in `date_created`, please use\ \ that one instead." Push.ApnCredentialSid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ description: Optional configuration for the Push factors. Set the APN Credential for this service. This will allow to send push notifications to iOS devices. See [Credential Resource](https://www.twilio.com/docs/notify/api/credential-resource) Push.FcmCredentialSid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ description: Optional configuration for the Push factors. Set the FCM Credential for this service. This will allow to send push notifications to Android devices. See [Credential Resource](https://www.twilio.com/docs/notify/api/credential-resource) Totp.Issuer: type: string description: Optional configuration for the TOTP factors. Set TOTP Issuer for this service. This will allow to configure the issuer of the TOTP URI. Defaults to the service friendly name if not provided. Totp.TimeStep: type: integer description: Optional configuration for the TOTP factors. Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive. Defaults to 30 seconds Totp.CodeLength: type: integer description: Optional configuration for the TOTP factors. Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive. Defaults to 6 Totp.Skew: type: integer description: Optional configuration for the TOTP factors. The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. Defaults to 1 DefaultTemplateSid: type: string minLength: 34 maxLength: 34 pattern: ^HJ[0-9a-fA-F]{32}$ description: The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only. Whatsapp.MsgServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ description: The SID of the Messaging Service containing WhatsApp Sender(s) that Verify will use to send WhatsApp messages to your users. Whatsapp.From: type: string description: The number to use as the WhatsApp Sender that Verify will use to send WhatsApp messages to your users.This WhatsApp Sender must be associated with a Messaging Service SID. VerifyEventSubscriptionEnabled: type: boolean description: Whether to allow verifications from the service to reach the stream-events sinks if configured required: - FriendlyName examples: createRecord: value: FriendlyName: name CodeLength: 4 LookupEnabled: false Psd2Enabled: false SkipSmsToLandlines: false DtmfInputRequired: false TtsName: name MailerSid: MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DoNotShareWarningEnabled: false CustomCodeEnabled: true Push.ApnCredentialSid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Totp.Issuer: test-issuer Totp.TimeStep: 30 Totp.CodeLength: 3 Totp.Skew: 2 DefaultTemplateSid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa VerifyEventSubscriptionEnabled: false get: description: Retrieve a list of all Verification Services for an account. summary: Retrieve a list of all Verification Services for an account. tags: - VerifyV2Service parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: services: type: array items: $ref: '#/components/schemas/verify.v2.service' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListServiceResponse examples: readAll: value: meta: page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Services?PageSize=50&Page=0 previous_page_url: null next_page_url: null key: services url: https://verify.twilio.com/v2/Services?PageSize=50&Page=0 services: - sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: name code_length: 4 lookup_enabled: false psd2_enabled: false skip_sms_to_landlines: false dtmf_input_required: false tts_name: name mailer_sid: MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa do_not_share_warning_enabled: false custom_code_enabled: true push: include_date: false apn_credential_sid: null fcm_credential_sid: null totp: issuer: null time_step: null code_length: null skew: null whatsapp: msg_service_sid: null from: null default_template_sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa verify_event_subscription_enabled: false date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: verification_checks: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/VerificationCheck verifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications rate_limits: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits messaging_configurations: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations entities: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities webhooks: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks access_tokens: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListService /v2/Services/{Sid}: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name - date_created dependentProperties: verifications: mapping: service_sid: sid resource_url: /v2/Services/{service_sid}/Verifications verification_checks: mapping: service_sid: sid resource_url: /v2/Services/{service_sid}/VerificationCheck rate_limits: mapping: service_sid: sid resource_url: /v2/Services/{service_sid}/RateLimits messaging_configurations: mapping: service_sid: sid resource_url: /v2/Services/{service_sid}/MessagingConfigurations entities: mapping: service_sid: sid resource_url: /v2/Services/{service_sid}/Entities webhooks: mapping: service_sid: sid resource_url: /v2/Services/{service_sid}/Webhooks access_tokens: mapping: service_sid: sid resource_url: /v2/Services/{service_sid}/AccessTokens pathType: instance get: description: Fetch specific Verification Service Instance. summary: Fetch specific Verification Service Instance. tags: - VerifyV2Service parameters: - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Verification Service resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service' examples: fetchRecord: value: sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: name code_length: 4 lookup_enabled: false psd2_enabled: false skip_sms_to_landlines: false dtmf_input_required: false tts_name: name mailer_sid: MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa do_not_share_warning_enabled: false custom_code_enabled: true push: include_date: false apn_credential_sid: null fcm_credential_sid: null totp: issuer: null time_step: null code_length: null skew: null whatsapp: msg_service_sid: null from: null default_template_sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa verify_event_subscription_enabled: false date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: verification_checks: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/VerificationCheck verifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications rate_limits: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits messaging_configurations: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations entities: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities webhooks: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks access_tokens: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchService delete: description: Delete a specific Verification Service Instance. summary: Delete a specific Verification Service Instance. tags: - VerifyV2Service parameters: - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Verification Service resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteService post: description: Update a specific Verification Service. summary: Update a specific Verification Service. tags: - VerifyV2Service parameters: - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Service resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service' examples: updateRecord: value: sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: name code_length: 4 lookup_enabled: false psd2_enabled: false skip_sms_to_landlines: false dtmf_input_required: false tts_name: name mailer_sid: MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa do_not_share_warning_enabled: false custom_code_enabled: true push: include_date: false apn_credential_sid: null fcm_credential_sid: CRbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb totp: issuer: test-issuer time_step: 30 code_length: 3 skew: 2 whatsapp: msg_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa from: whatsapp:+1234567890 default_template_sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa verify_event_subscription_enabled: false date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: verification_checks: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/VerificationCheck verifications: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications rate_limits: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits messaging_configurations: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingConfigurations entities: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Entities webhooks: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks access_tokens: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AccessTokens headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateService requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateServiceRequest properties: FriendlyName: type: string description: A descriptive string that you create to describe the verification service. It can be up to 32 characters long. **This value should not contain PII.** CodeLength: type: integer description: The length of the verification code to generate. Must be an integer value between 4 and 10, inclusive. LookupEnabled: type: boolean description: Whether to perform a lookup with each verification started and return info about the phone number. SkipSmsToLandlines: type: boolean description: Whether to skip sending SMS verifications to landlines. Requires `lookup_enabled`. DtmfInputRequired: type: boolean description: Whether to ask the user to press a number before delivering the verify code in a phone call. TtsName: type: string description: The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages. Psd2Enabled: type: boolean description: Whether to pass PSD2 transaction parameters when starting a verification. DoNotShareWarningEnabled: type: boolean description: Whether to add a privacy warning at the end of an SMS. **Disabled by default and applies only for SMS.** CustomCodeEnabled: type: boolean description: Whether to allow sending verifications with a custom code instead of a randomly generated one. Push.IncludeDate: type: boolean description: "Optional configuration for the Push factors. If true,\ \ include the date in the Challenge's response. Otherwise, the\ \ date is omitted from the response. See [Challenge](https://www.twilio.com/docs/verify/api/challenge)\ \ resource\u2019s details parameter for more info. Default: false.\ \ **Deprecated** do not use this parameter." Push.ApnCredentialSid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ description: Optional configuration for the Push factors. Set the APN Credential for this service. This will allow to send push notifications to iOS devices. See [Credential Resource](https://www.twilio.com/docs/notify/api/credential-resource) Push.FcmCredentialSid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ description: Optional configuration for the Push factors. Set the FCM Credential for this service. This will allow to send push notifications to Android devices. See [Credential Resource](https://www.twilio.com/docs/notify/api/credential-resource) Totp.Issuer: type: string description: Optional configuration for the TOTP factors. Set TOTP Issuer for this service. This will allow to configure the issuer of the TOTP URI. Totp.TimeStep: type: integer description: Optional configuration for the TOTP factors. Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive. Defaults to 30 seconds Totp.CodeLength: type: integer description: Optional configuration for the TOTP factors. Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive. Defaults to 6 Totp.Skew: type: integer description: Optional configuration for the TOTP factors. The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. Defaults to 1 DefaultTemplateSid: type: string minLength: 34 maxLength: 34 pattern: ^HJ[0-9a-fA-F]{32}$ description: The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only. Whatsapp.MsgServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services) to associate with the Verification Service. Whatsapp.From: type: string description: The WhatsApp number to use as the sender of the verification messages. This number must be associated with the WhatsApp Message Service. VerifyEventSubscriptionEnabled: type: boolean description: Whether to allow verifications from the service to reach the stream-events sinks if configured examples: updateRecord: value: FriendlyName: name CodeLength: 4 LookupEnabled: false Psd2Enabled: false SkipSmsToLandlines: false DtmfInputRequired: false TtsName: name MailerSid: MDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DoNotShareWarningEnabled: false CustomCodeEnabled: true Push.IncludeDate: false Push.FcmCredentialSid: CRbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb Totp.Issuer: test-issuer Totp.TimeStep: 30 Totp.CodeLength: 3 Totp.Skew: 2 DefaultTemplateSid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa VerifyEventSubscriptionEnabled: false /v2/Services/{ServiceSid}/Verifications: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - to - channel - status - valid - date_created parent: /Services/{Sid} pathType: list post: description: Create a new Verification using a Service summary: Create a new Verification using a Service tags: - VerifyV2Verification parameters: - name: ServiceSid in: path description: The SID of the verification [Service](https://www.twilio.com/docs/verify/api/service) to create the resource under. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.verification' examples: createVerification: value: sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: '+15017122661' channel: sms status: pending valid: false date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' lookup: {} amount: null payee: null send_code_attempts: - time: '2015-07-30T20:00:00Z' channel: SMS attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sna: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createVerificationWhatsapp: value: sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: '+15017122661' channel: whatsapp status: pending valid: false date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' lookup: {} amount: null payee: null send_code_attempts: - time: '2015-07-30T20:00:00Z' channel: whatsapp attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sna: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createVerificationEmail: value: sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: mail@email.com channel: email status: pending valid: false date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' lookup: {} amount: null payee: null send_code_attempts: - time: '2015-07-30T20:00:00Z' channel: EMAIL attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sna: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createVerificationWithRateLimits: value: sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: '+15017122661' channel: sms status: pending valid: false date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' lookup: {} amount: null payee: null send_code_attempts: - time: '2015-07-30T20:00:00Z' channel: SMS attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sna: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createVerificationSna: value: sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: '+15017122661' channel: sna status: pending valid: false date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' lookup: carrier: mobile_country_code: '311' type: mobile error_code: null mobile_network_code: '180' name: T-Mobile USA, Inc. amount: null payee: null send_code_attempts: - time: '2015-07-30T20:00:00Z' channel: sna attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sna: url: https://mi.dnlsrv.com/m/id/ANBByzx7?data=AAAglRRdNn02iTFWfDWwdTjOzM8o%2F6JB86fH%2Bt%2FFftUPj0pFA0u8%2FibWuYwzmMeMOtdTwYlsO8V%2FXF%2BJmngMhbeGKYhHeTOF2H9VrGEYKcEEklPxHgb5GgL3XtYa33j3lIU%2By6InvoV%2FowWHBzA0QeFPBh6vmJ8LoUPJqGE7q0PRz618Z4ym1AGq%2BaomSq9PlP4rCduv9Cmtxu%2FrvPSBwocs0GCWDE8seK8t9epmPQW7gwODxkAiKr9UxhJd9KvmBVuAQPf%2BoFQVo86USXkhXqTvUzB2bNUYY9FCy3CWgZFTOa1D3H1CVxf1eHzYIswNA7SmOzP%2FBX8g6%2B0hkzwMRkcit3gBNs4evAVJiqAgYvUlrtGwwv9bFx4X7jWSHY4%3D&cipherSalt=yANeDq09bwM38SJs url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createVerificationAuto: value: sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: '+15017122661' channel: sna status: pending valid: false date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' lookup: carrier: mobile_country_code: '311' type: mobile error_code: null mobile_network_code: '180' name: T-Mobile USA, Inc. amount: null payee: null send_code_attempts: - time: '2015-07-30T20:00:00Z' channel: sna attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sna: url: https://mi.dnlsrv.com/m/id/ANBByzx7?data=AAAglRRdNn02iTFWfDWwdTjOzM8o%2F6JB86fH%2Bt%2FFftUPj0pFA0u8%2FibWuYwzmMeMOtdTwYlsO8V%2FXF%2BJmngMhbeGKYhHeTOF2H9VrGEYKcEEklPxHgb5GgL3XtYa33j3lIU%2By6InvoV%2FowWHBzA0QeFPBh6vmJ8LoUPJqGE7q0PRz618Z4ym1AGq%2BaomSq9PlP4rCduv9Cmtxu%2FrvPSBwocs0GCWDE8seK8t9epmPQW7gwODxkAiKr9UxhJd9KvmBVuAQPf%2BoFQVo86USXkhXqTvUzB2bNUYY9FCy3CWgZFTOa1D3H1CVxf1eHzYIswNA7SmOzP%2FBX8g6%2B0hkzwMRkcit3gBNs4evAVJiqAgYvUlrtGwwv9bFx4X7jWSHY4%3D&cipherSalt=yANeDq09bwM38SJs url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Retry-After: schema: type: string Twilio-Reached-Rate-Limit: schema: type: string Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateVerification requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateVerificationRequest properties: To: type: string description: The phone number or [email](https://www.twilio.com/docs/verify/email) to verify. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). Channel: type: string description: 'The verification method to use. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, `sna` or `auto`.' CustomFriendlyName: type: string description: A custom user defined friendly name that overwrites the existing one in the verification message CustomMessage: type: string description: The text of a custom message to use for the verification. SendDigits: type: string description: The digits to send after a phone call is answered, for example, to dial an extension. For more information, see the Programmable Voice documentation of [sendDigits](https://www.twilio.com/docs/voice/twiml/number#attributes-sendDigits). Locale: type: string description: "Locale will automatically resolve based on phone number\ \ country code for SMS, WhatsApp, and call channel verifications.\ \ It will fallback to English or the template\u2019s default translation\ \ if the selected translation is not available. This parameter\ \ will override the automatic locale resolution. [See supported\ \ languages and more information here](https://www.twilio.com/docs/verify/supported-languages)." CustomCode: type: string description: A pre-generated code to use for verification. The code can be between 4 and 10 characters, inclusive. Amount: type: string description: The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. Payee: type: string description: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. RateLimits: description: The custom key-value pairs of Programmable Rate Limits. Keys correspond to `unique_name` fields defined when [creating your Rate Limit](https://www.twilio.com/docs/verify/api/service-rate-limits). Associated value pairs represent values in the request that you are rate limiting on. You may include multiple Rate Limit values in each request. ChannelConfiguration: description: '[`email`](https://www.twilio.com/docs/verify/email) channel configuration in json format. The fields ''from'' and ''from_name'' are optional but if included the ''from'' field must have a valid email address.' AppHash: type: string description: 'Your [App Hash](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string) to be appended at the end of your verification SMS body. Applies only to SMS. Example SMS body: `<#> Your AppName verification code is: 1234 He42w354ol9`.' TemplateSid: type: string minLength: 34 maxLength: 34 pattern: ^HJ[0-9a-fA-F]{32}$ description: The message [template](https://www.twilio.com/docs/verify/api/templates). If provided, will override the default template for the Service. SMS and Voice channels only. TemplateCustomSubstitutions: type: string description: A stringified JSON object in which the keys are the template's special variables and the values are the variables substitutions. DeviceIp: type: string description: Strongly encouraged if using the auto channel. The IP address of the client's device. If provided, it has to be a valid IPv4 or IPv6 address. EnableSnaClientToken: type: boolean description: An optional Boolean value to indicate the requirement of sna client token in the SNA URL invocation response for added security. This token must match in the Verification Check request to confirm phone number verification. RiskCheck: $ref: '#/components/schemas/verification_enum_risk_check' Tags: type: string description: A string containing a JSON map of key value pairs of tags to be recorded as metadata for the message. The object may contain up to 10 tags. Keys and values can each be up to 128 characters in length. required: - To - Channel examples: createVerification: value: To: '+15017122661' Channel: sms CustomCode: custom_code CustomFriendlyName: custom_friendly_name CustomMessage: custom_message SendDigits: ww1 Locale: en Amount: "\u20AC39.99" Payee: Acme Inc. AppHash: AAAAAAAAAAA TemplateSid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa TemplateCustomSubstitutions: '{"AppName": "MyApp", "Contact":"12345689"}' RiskCheck: enable Tags: '{"tenant_id": "12345"}' createVerificationWhatsapp: value: To: '+15017122661' Channel: whatsapp CustomCode: custom_code CustomFriendlyName: custom_friendly_name Locale: en createVerificationEmail: value: To: mail@email.com Channel: email CustomCode: custom_code CustomMessage: custom_message Locale: en Amount: "\u20AC39.99" Payee: Acme Inc. ChannelConfiguration: '{"from": "foo@bar.com", "from_name": "Bar Inc.", "substitutions": { "username": "ms. baz" }, "template_id": "Dxxxxxxxxxx"}' createVerificationWithRateLimits: value: To: '+15017122661' Channel: sms CustomCode: custom_code CustomMessage: custom_message SendDigits: ww1 Locale: en RateLimits: '{"my_rate_limit_key": "abc"}' createVerificationSna: value: To: '+15017122661' Channel: sna createVerificationAuto: value: To: '+15017122661' Channel: auto DeviceIp: 0.000.00.000 /v2/Services/{ServiceSid}/Verifications/{Sid}: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - to - channel - status - valid - date_created parent: /Services/{Sid} pathType: instance post: description: Update a Verification status summary: Update a Verification status tags: - VerifyV2Verification parameters: - name: ServiceSid in: path description: The SID of the verification [Service](https://www.twilio.com/docs/verify/api/service) to update the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Verification resource to update. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.verification' examples: updateVerification: value: sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: '+15017122661' channel: sms status: canceled valid: false date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' lookup: {} amount: null payee: null send_code_attempts: - time: '2015-07-30T20:00:00Z' channel: SMS attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sna: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa approveVerificationWithPn: value: sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: '+15017122661' channel: sms status: approved valid: true date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' lookup: {} amount: null payee: null send_code_attempts: - time: '2015-07-30T20:00:00Z' channel: SMS attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sna: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateVerification requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateVerificationRequest properties: Status: $ref: '#/components/schemas/verification_enum_status' required: - Status examples: updateVerification: value: Status: canceled approveVerificationWithPn: value: Status: approved get: description: Fetch a specific Verification summary: Fetch a specific Verification tags: - VerifyV2Verification parameters: - name: ServiceSid in: path description: The SID of the verification [Service](https://www.twilio.com/docs/verify/api/service) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Verification resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.verification' examples: fetchVerification: value: sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: '+15017122661' channel: sms status: pending valid: false date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' lookup: {} amount: null payee: null send_code_attempts: - time: '2015-07-30T20:00:00Z' channel: SMS attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sna: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchVerification /v2/Attempts: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - date_created - date_updated - conversion_status - channel mountName: verification_attempts pathType: list get: description: List all the verification attempts for a given Account. summary: List all the verification attempts for a given Account. tags: - VerifyV2VerificationAttempt parameters: - name: DateCreatedAfter in: query description: 'Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd''T''HH:mm:ss''Z.' schema: type: string format: date-time - name: DateCreatedBefore in: query description: 'Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd''T''HH:mm:ss''Z.' schema: type: string format: date-time - name: ChannelData.To in: query description: Destination of a verification. It is phone number in E.164 format. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 - name: Country in: query description: Filter used to query Verification Attempts sent to the specified destination country. schema: type: string format: iso-country-code - name: Channel in: query description: Filter used to query Verification Attempts by communication channel. schema: $ref: '#/components/schemas/verification_attempt_enum_channels' - name: VerifyServiceSid in: query description: Filter used to query Verification Attempts by verify service. Only attempts of the provided SID will be returned. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ - name: VerificationSid in: query description: Filter used to return all the Verification Attempts of a single verification. Only attempts of the provided verification SID will be returned. schema: type: string minLength: 34 maxLength: 34 pattern: ^VE[0-9a-fA-F]{32}$ - name: Status in: query description: Filter used to query Verification Attempts by conversion status. Valid values are `UNCONVERTED`, for attempts that were not converted, and `CONVERTED`, for attempts that were confirmed. schema: $ref: '#/components/schemas/verification_attempt_enum_conversion_status' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: attempts: type: array items: $ref: '#/components/schemas/verify.v2.verification_attempt' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListVerificationAttemptResponse examples: listVerificationAttemptsEmpty: value: attempts: [] meta: key: attempts page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0 previous_page_url: null url: https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0 next_page_url: null listVerificationAttempts: value: attempts: - sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa verification_sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2020-08-11T18:36:59Z' date_updated: '2020-08-11T18:37:00Z' conversion_status: unconverted channel: sms price: value: '0.005' currency: usd channel_data: verification_sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: '+573003003030' status: unconfirmed message_status: undelivered error_code: '30008' country: CO code_length: 6 locale: es mcc: '732' mnc: '103' carrier: Colombia Movil (Tigo) url: https://verify.twilio.com/v2/Attempts/VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: key: attempts page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0 previous_page_url: null url: https://verify.twilio.com/v2/Attempts?PageSize=50&Page=0 next_page_url: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListVerificationAttempt /v2/Attempts/{Sid}: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - date_created - date_updated - conversion_status - channel mountName: verification_attempts pathType: instance get: description: Fetch a specific verification attempt. summary: Fetch a specific verification attempt. tags: - VerifyV2VerificationAttempt parameters: - name: Sid in: path description: The unique SID identifier of a Verification Attempt schema: type: string minLength: 34 maxLength: 34 pattern: ^VL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.verification_attempt' examples: fetchVerificationAttempt: value: sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa verification_sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2020-08-11T18:36:59Z' date_updated: '2020-08-11T18:37:00Z' conversion_status: unconverted channel: sms price: value: '0.005' currency: usd channel_data: verification_sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: '+573003003030' status: unconfirmed message_status: undelivered error_code: '30008' country: CO code_length: 6 locale: es mcc: '732' mnc: '103' carrier: Colombia Movil (Tigo) url: https://verify.twilio.com/v2/Attempts/VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchVerificationAttempt /v2/Attempts/Summary: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - total_attempts - total_converted - total_unconverted - conversion_rate_percentage mountName: verification_attempts_summary pathType: instance get: description: Get a summary of how many attempts were made and how many were converted. summary: Get a summary of how many attempts were made and how many were converted. tags: - VerifyV2VerificationAttemptsSummary parameters: - name: VerifyServiceSid in: query description: Filter used to consider only Verification Attempts of the given verify service on the summary aggregation. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ examples: getAttemptsSummary: value: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: DateCreatedAfter in: query description: 'Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd''T''HH:mm:ss''Z.' schema: type: string format: date-time examples: getAttemptsSummary: value: '2022-03-02T21:02:33Z' - name: DateCreatedBefore in: query description: 'Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd''T''HH:mm:ss''Z.' schema: type: string format: date-time examples: getAttemptsSummary: value: '2022-03-02T21:02:33Z' - name: Country in: query description: Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation. schema: type: string format: iso-country-code examples: getAttemptsSummary: value: CO - name: Channel in: query description: Filter Verification Attempts considered on the summary aggregation by communication channel. schema: $ref: '#/components/schemas/verification_attempts_summary_enum_channels' examples: getAttemptsSummary: value: sms - name: DestinationPrefix in: query description: Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format. schema: type: string examples: getAttemptsSummary: value: '+57305' responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.verification_attempts_summary' examples: getAttemptsSummary: value: total_attempts: 11 total_converted: 9 total_unconverted: 2 conversion_rate_percentage: '81.818181818' url: https://verify.twilio.com/v2/Attempts/Summary headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchVerificationAttemptsSummary /v2/Services/{ServiceSid}/VerificationCheck: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - to - channel - status - valid - date_created parent: /Services/{Sid} mountName: verification_checks pathType: list post: description: challenge a specific Verification Check. summary: challenge a specific Verification Check. tags: - VerifyV2VerificationCheck parameters: - name: ServiceSid in: path description: The SID of the verification [Service](https://www.twilio.com/docs/verify/api/service) to create the resource under. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.verification_check' examples: verificationChecks: value: sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: '+15017122661' channel: sms status: approved valid: true amount: null payee: null sna_attempts_error_codes: [] date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' emailVerificationChecks: value: sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: recipient@foo.com channel: email status: approved valid: true amount: null payee: null sna_attempts_error_codes: [] date_created: '2020-01-30T20:00:00Z' date_updated: '2020-01-30T20:00:00Z' snaVerificationChecks: value: sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: '+15017122661' channel: sna status: approved valid: true amount: null payee: null sna_attempts_error_codes: - attempt_sid: VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa code: 60001 date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.verification_check' examples: verificationChecks200: value: sid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: '+15017122661' channel: sms status: approved valid: true amount: null payee: null sna_attempts_error_codes: [] date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: CreateVerificationCheck requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateVerificationCheckRequest properties: Code: type: string description: The 4-10 character string being verified. To: type: string description: The phone number or [email](https://www.twilio.com/docs/verify/email) to verify. Either this parameter or the `verification_sid` must be specified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). VerificationSid: type: string minLength: 34 maxLength: 34 pattern: ^VE[0-9a-fA-F]{32}$ description: A SID that uniquely identifies the Verification Check. Either this parameter or the `to` phone number/[email](https://www.twilio.com/docs/verify/email) must be specified. Amount: type: string description: The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. Payee: type: string description: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. SnaClientToken: type: string description: A sna client token received in sna url invocation response needs to be passed in Verification Check request and should match to get successful response. examples: verificationChecks: value: To: '+15017122661' VerificationSid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Code: '1234' Amount: "\u20AC39.99" Payee: Acme Inc. emailVerificationChecks: value: To: recipient@foo.com VerificationSid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Code: '123456' verificationChecks200: value: To: '+15017122661' VerificationSid: VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Code: '1234' Amount: "\u20AC39.99" Payee: Acme Inc. snaVerificationChecks: value: To: '+15017122661' /v2/Templates: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - friendly_name pathType: list get: description: List all the available templates for a given Account. summary: List all the available templates for a given Account. tags: - VerifyV2Template parameters: - name: FriendlyName in: query description: String filter used to query templates with a given friendly name. schema: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: templates: type: array items: $ref: '#/components/schemas/verify.v2.verification_template' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListVerificationTemplateResponse examples: listVerificationTemplates: value: templates: - sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Base Verification Template 2 with do not share channels: - sms translations: en: is_default_translation: true status: approved locale: en text: 'Your {{friendly_name}} verification code is: {{code}}. Do not share this code with anyone.' date_updated: '2021-07-29T20:38:28.759979905Z' date_created: '2021-07-29T20:38:28.165602325Z' - sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Base Verification Template 3 channels: - sms - voice translations: en: is_default_translation: true status: approved locale: en text: 'Your verification code is: {{code}}. Do not share it.' date_updated: '2021-07-29T20:38:28.759979905Z' date_created: '2021-07-29T20:38:28.165602325Z' meta: page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Templates?PageSize=50&Page=0 previous_page_url: null url: https://verify.twilio.com/v2/Templates?PageSize=50&Page=0 next_page_url: null key: templates headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListVerificationTemplate /v2/Services/{ServiceSid}/Webhooks: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - service_sid - friendly_name - event_types - webhook_url - webhook_method - status - date_created parent: /Services/{Sid} pathType: list post: description: Create a new Webhook for the Service summary: Create a new Webhook for the Service tags: - VerifyV2Webhook parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.webhook' examples: create: value: url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: name event_types: - factor.deleted - factor.verified webhook_method: POST webhook_url: https://owlbank.twilio.com status: enabled version: v2 date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateWebhook requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateWebhookRequest properties: FriendlyName: type: string description: The string that you assigned to describe the webhook. **This value should not contain PII.** EventTypes: type: array items: type: string description: 'The array of events that this Webhook is subscribed to. Possible event types: `*, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied`' WebhookUrl: type: string description: The URL associated with this Webhook. Status: $ref: '#/components/schemas/webhook_enum_status' Version: $ref: '#/components/schemas/webhook_enum_version' required: - FriendlyName - EventTypes - WebhookUrl examples: create: value: FriendlyName: name EventTypes: - factor.deleted - factor.verified WebhookUrl: https://owlbank.twilio.com Version: v2 get: description: Retrieve a list of all Webhooks for a Service. summary: Retrieve a list of all Webhooks for a Service. tags: - VerifyV2Webhook parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: webhooks: type: array items: $ref: '#/components/schemas/verify.v2.service.webhook' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListWebhookResponse examples: readEmpty: value: webhooks: [] meta: page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 previous_page_url: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 next_page_url: null key: webhooks readFull: value: webhooks: - url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: name event_types: - factor.deleted - factor.verified webhook_method: POST webhook_url: https://owlbank.twilio.com status: enabled version: v2 date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' meta: page: 0 page_size: 50 first_page_url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 previous_page_url: null url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 next_page_url: null key: webhooks headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListWebhook /v2/Services/{ServiceSid}/Webhooks/{Sid}: servers: - url: https://verify.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - service_sid - friendly_name - event_types - webhook_url - webhook_method - status - date_created parent: /Services/{Sid} pathType: instance post: description: '' summary: '' tags: - VerifyV2Webhook parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Webhook resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^YW[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.webhook' examples: update: value: url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: name event_types: - factor.deleted - factor.verified webhook_method: POST webhook_url: https://owlbank.twilio.com status: disabled version: v2 date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateWebhook requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateWebhookRequest properties: FriendlyName: type: string description: The string that you assigned to describe the webhook. **This value should not contain PII.** EventTypes: type: array items: type: string description: 'The array of events that this Webhook is subscribed to. Possible event types: `*, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied`' WebhookUrl: type: string description: The URL associated with this Webhook. Status: $ref: '#/components/schemas/webhook_enum_status' Version: $ref: '#/components/schemas/webhook_enum_version' examples: update: value: FriendlyName: name EventTypes: - factor.deleted - factor.verified WebhookUrl: https://owlbank.twilio.com Status: disabled Version: v2 delete: description: Delete a specific Webhook. summary: Delete a specific Webhook. tags: - VerifyV2Webhook parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Webhook resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^YW[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteWebhook get: description: Fetch a specific Webhook. summary: Fetch a specific Webhook. tags: - VerifyV2Webhook parameters: - name: ServiceSid in: path description: The unique SID identifier of the Service. schema: type: string minLength: 34 maxLength: 34 pattern: ^VA[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The Twilio-provided string that uniquely identifies the Webhook resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^YW[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/verify.v2.service.webhook' examples: fetch: value: url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: YWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: name event_types: - factor.deleted - factor.verified webhook_method: POST webhook_url: https://owlbank.twilio.com status: enabled version: v2 date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchWebhook servers: - url: https://verify.twilio.com tags: - name: VerifyV2AccessToken - name: VerifyV2Bucket - name: VerifyV2Challenge - name: VerifyV2Entity - name: VerifyV2Factor - name: VerifyV2Form - name: VerifyV2MessagingConfiguration - name: VerifyV2NewFactor - name: VerifyV2Notification - name: VerifyV2RateLimit - name: VerifyV2Safelist - name: VerifyV2Service - name: VerifyV2Template - name: VerifyV2Verification - name: VerifyV2VerificationAttempt - name: VerifyV2VerificationAttemptsSummary - name: VerifyV2VerificationCheck - name: VerifyV2Webhook security: - accountSid_authToken: []