GET/api/v1/verify
Verifications your app started, newest first.
- CLI
sendmock verify list- MCP tool
sendmock_verify_list- In the app
- SMS > Verify
Answer
200 PageOf_Verification
/api/v1/verifyVerifications your app started, newest first.
sendmock verify listsendmock_verify_list200 PageOf_Verification
/api/v1/verify/{verificationSid}One verification with its code, attempts and timeline.
sendmock verify show <verificationSid>sendmock_verify_get200 VerificationDetail
Errors: 404, as { error: { code, message } }
/api/v1/verify/{verificationSid}/forceForce an outcome: approved, expired, canceled or max attempts.
sendmock verify force <verificationSid> <status>sendmock_verify_forceVerificationForceRequest : Body of `POST /verify/{verificationSid}/force`.
| Field | Type | Description |
|---|---|---|
| state | ForcedVerificationState | The state to force: approved, canceled, expired or max_attempts (too many wrong checks).One of: approved, canceled, expired, max_attemptsExample: expired |
200 VerificationDetail
Errors: 404, as { error: { code, message } }
/api/v1/verify/servicesVerify services (code length, fixed code, lifetime).
sendmock verify services listsendmock_verify_service_list200 VerifyService[]
/api/v1/verify/servicesAdd a Verify service.
sendmock verify services createsendmock_verify_service_createVerifyServiceInput : Body of POST and PATCH /api/v1/verify/services.
| Field | Type | Description |
|---|---|---|
| friendly_name | string | The name shown in the code message, e.g. "Your Shop verification code is ...".Example: Shop |
| code_length | number | Digits in each code, 4 to 10.Example: 6 |
| fixed_code | string | null | Always send this code instead of a random one, for deterministic tests; null for random.Example: 123456 |
| ttl_seconds | number | How long a code stays valid, in seconds.Example: 600 |
201 VerifyService
Errors: 400, as { error: { code, message } }
/api/v1/verify/services/{serviceSid}Change a Verify service.
sendmock verify services update <serviceSid>sendmock_verify_service_updateVerifyServiceInput : Body of POST and PATCH /api/v1/verify/services.
| Field | Type | Description |
|---|---|---|
| friendly_name | string | The name shown in the code message, e.g. "Your Shop verification code is ...".Example: Shop |
| code_length | number | Digits in each code, 4 to 10.Example: 6 |
| fixed_code | string | null | Always send this code instead of a random one, for deterministic tests; null for random.Example: 123456 |
| ttl_seconds | number | How long a code stays valid, in seconds.Example: 600 |
200 VerifyService
Errors: 400, 404, as { error: { code, message } }
/api/v1/verify/services/{serviceSid}Delete a Verify service.
sendmock verify services delete <serviceSid>sendmock_verify_service_delete204 No content