create otp request

post

https://waapi.app/api/v1/instances/{id}/otp

Start a verification. Returns a keyword and a link that opens a pre-filled message to the instance's number; the end user sends it and receives the code. Without identity the request registers a new account (mode register); with an identity returned earlier it checks that the same account answers (mode check). The request is valid for 10 minutes. Needs the update ability.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

401

Unauthorized — invalid or missing bearer token

403

Forbidden — insufficient permissions or account blocked

404

Not found — instance or verification request does not exist or does not belong to you

`otp_disabled`: verification is switched off for this instance

`invalid_identity` (flat error) when `identity` is not a value returned by this API; the usual validation envelope for `locale` and `app_name`.

create otp request

`otp_disabled`: verification is switched off for this instance

`invalid_identity` (flat error) when `identity` is not a value returned by this API; the usual validation envelope for `locale` and `app_name`.

`rate_limited`: the instance or customer budget is spent. Retry after the `Retry-After` header (seconds).

`instance_not_ready`: the instance is offline, restarting or cannot run verification right now

201The created verification request

409Conflict — otp_disabled: verification is switched off for this instance

422Validation error. invalid_identity (flat error) when identity is not a value returned by this API; the usual validation envelope for locale and app_name.

429Too many requests — rate_limited: the instance or customer budget is spent. Retry after the Retry-After header (seconds).

503Service unavailable — instance_not_ready: the instance is offline, restarting or cannot run verification right now

`otp_disabled`: verification is switched off for this instance

`invalid_identity` (flat error) when `identity` is not a value returned by this API; the usual validation envelope for `locale` and `app_name`.

`rate_limited`: the instance or customer budget is spent. Retry after the `Retry-After` header (seconds).

`instance_not_ready`: the instance is offline, restarting or cannot run verification right now