Update a verification process

patch

https://verify.telesign.com/verification/{reference_id}/state

Use this action to change the state of an active verification process. This is typically used to finalize a verification process managed solely via interactions with this REST API.

📘
NOTE:
Updating a verification process using the procedure explained in each channel's Complete verification and get delivery status section on its Get Started page is a mandatory step when using Verify API. This step allows Telesign to know the real state of your verification as well as control all the features related to a verification process such as fallback, callback, and pricing. If your end user has verified themselves but the verification process is not updated, these features might not work as intended which can lead to extra costs or incorrect billing.

General requirements

Authentication: Basic (easiest to implement) or Digest
Encoding: Accepts only UTF-8 unicode characters as inputs.
Accepts: application/json
Responds with: application/json
Required headers: Content-Type - application/json
Rate limit: Default rate limits by product

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

reference_id

string

required

Identifier of the verification to be altered. The value has been returned upon requesting verification via POST method.

Body Params

Payload for request to update a verification process.

action

string

required

Specifies how you want to change the verification state for this verification process. Use one of these values:

"finalize" - Finalize this verification process. Telesign either verifies or rejects at this stage.

security_factor

string

required

length between 3 and 10

If Telesign has sent a one-time passcode (OTP) to your end user as part of this verification process, include the asserted OTP from your end user here. If Telesign generated the code, this is necessary to determine if the OTPs match. If you generated the code, this is necessary to end the verification process and avoid added costs due to additional sends to the end user.

Responses

Status code	Associated text string	Description
3900	Verified	The asserted OTP and the OTP generated by Telesign match. Verification process completed successfully.
3904	Verification Failed	The asserted OTP and the OTP generated by Telesign do not match. Verification process continues if retries are still available.
3909	Invalid code entered	The asserted OTP and the OTP generated by Telesign do not match, and also did not match in two previous attempts. Verification process completed unsuccessfully.

Status.code	Status.Description	Additional details
3101	Invalid value for parameter phone_number: {phone_number}	Phone number is too long, too short, or contains non-digit values.
3103	Unsupported value for parameter external_id	External ID is longer than 100 characters or contains non-ASCII characters.
3110	Invalid request	The API request or its JSON payload is improperly formatted.
3302	Missing parameter phone_number	The API request does not contain the mandatory parameter `phone_number`.

Status.code	Status.Description	Additional details
3203	Callback URL parameter not enabled for Customer ID	Using callback_url in the API request is not allowed for this account.
3400	Not authorized	No permissions for this resource or authorization failed.
3906	Unified Verification Product not enabled for Customer ID	This product is not enabled for this account.