Verification Object
This is a representation of a registered verification request. It contains all the original requesting details, the information needed by the requester to proceed, and a status indicating its progress.
Body Parameters
Field | Type | Description | Nullable |
---|---|---|---|
ID | String | Unique identifier for the verification. | ✅ |
phoneNumber | String | The phone number to verify | ❌ |
countryCode | String | The country code of the phone number. Check supported countries to determine what phone numbers can be verified. We are always adding more. | ❌ |
agentNumber | String | The phone number to text (for SMS type), or to call (for DROPPED_CALL type). The field will be null for RECEIVED_CALL | ❌ |
status | VerificationStatus | The current status of the verification request. See VerificationStatus | ❌ |
type | VerificationType | The selected type of verification. VerificationType | ❌ |
reference | String | The current status of the verification request. See VerificationStatus | ✅ |
webhook | String | The current status of the verification request. See VerificationStatus | ✅ |