REST ClientVerified Callers

submitVerification

View as MarkdownOpen in Claude

Submit the verification code received during the verification call or SMS.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the verified caller ID.

Request

verification_codestringRequired
The verification code received via call or SMS.

Response

idstringRequiredformat: "uuid"
The unique identifier of the Verified Caller ID on SignalWire.
numberstringRequired
String representing the phone number for the caller ID. This must be a valid, routeable phone number in E.164 format.
verifiedbooleanRequired
A boolean representing whether the number has been verified or not.
typestringOptional
The type of the returned object, this should be verified_caller_id.
namestringOptional
String representing the name portion of the caller ID. If not provided, the default will be the formatted number that has been provided.
extensionstringOptional
String representing the extension of the phone number for the caller ID. This is only used when placing the verification call.
verified_atdatetimeOptional
Nullable DateTime field representing the date and time that the number was verified. If the number has not been verified, it will be null.
statusenumOptional
The verification status for the caller ID.
Allowed values:

Response Example

Response
1{
2  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3  "number": "+15551234567",
4  "verified": false,
5  "type": "verified_caller_id",
6  "name": "C-3P0",
7  "extension": "1234",
8  "verified_at": "2024-01-15T09:30:00Z",
9  "status": "Awaiting Verification"
10}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com"
7});
8
9const result = await client.verifiedCallers.submitVerification("caller-id", {
10    verification_code: "123456",
11});
12console.log("State:", result.verificationState);