Preview: SendMock has no stable release yet. These docs follow develop.

CLI reference

Verify commands

sendmock verify force

Force an outcome: approved, expired, canceled or max attempts.

sendmock verify force <verificationSid> <status>
ArgumentTypeDescription
<verificationSid>requiredstring
The verification's SID, from GET /api/v1/verify.Example: VE00000000000000000000000000000001
<status>requiredstring
The state to force: approved, canceled, expired or max_attempts (too many wrong checks).One of: approved, canceled, expired, max_attemptsExample: expired

Example

sendmock verify force VE00000000000000000000000000000001 expired

Output with --json: VerificationDetail. Exit codes: 0, 1, 2, 3.

API
POST/api/v1/verify/{verificationSid}/force
MCP tool
sendmock_verify_force
In the app
SMS > Verify > verification > Approve, Cancel, Expire, Max attempts

sendmock verify list

Verifications your app started, newest first.

sendmock verify list [flags]
FlagTypeDescription
--cursor <cursor>string
The next_cursor of the previous page.Example: 01JB7T9Q2R5W8X3Y6Z1A4B7C9D
--limit <limit>integer
Items per page, 1 to 200 (default 50).Example: 50
--status <status>string
pending, approved or failed.Example: pending
--to <to>string
Number or email.Example: +8801700000000
--channel <channel>string
How the code was sent.One of: sms, whatsapp, email, callExample: sms
--project <project>string
Only this project's verifications (its key); every project's when not set.Example: shop

Example

sendmock verify list --cursor 01JB7T9Q2R5W8X3Y6Z1A4B7C9D --limit 50

Output with --json: PageOf_Verification. Exit codes: 0, 1, 2.

API
GET/api/v1/verify
MCP tool
sendmock_verify_list
In the app
SMS > Verify

sendmock verify services create

Add a Verify service.

sendmock verify services create [flags]
FlagTypeDescription
--friendly-name <friendly-name>requiredstring
The name shown in the code message, e.g. "Your Shop verification code is ...".Example: Shop
--code-length <code-length>requirednumber
Digits in each code, 4 to 10.Example: 6
--fixed-code <fixed-code>string
Always send this code instead of a random one, for deterministic tests; null for random.Example: 123456
--ttl-seconds <ttl-seconds>requirednumber
How long a code stays valid, in seconds.Example: 600

Example

sendmock verify services create --friendly-name Shop --code-length 6 --ttl-seconds 600 --fixed-code 123456

Output with --json: VerifyService. Exit codes: 0, 1, 2.

API
POST/api/v1/verify/services
MCP tool
sendmock_verify_service_create
In the app
SMS > Verify > Services > New service

sendmock verify services delete

Delete a Verify service.

sendmock verify services delete <serviceSid> [flags]
ArgumentTypeDescription
<serviceSid>requiredstring
The service SID: MG... for a Messaging Service, VA... for a Verify service.Example: MG00000000000000000000000000000001
FlagTypeDescription
--yesboolean
Confirms a destructive command; without it the command stops.

Example

sendmock verify services delete MG00000000000000000000000000000001 --yes

Output with --json: nothing. Exit codes: 0, 1, 2.

API
DELETE/api/v1/verify/services/{serviceSid}
MCP tool
sendmock_verify_service_delete
In the app
SMS > Verify > Services > Delete

sendmock verify services update

Change a Verify service.

sendmock verify services update <serviceSid> [flags]
ArgumentTypeDescription
<serviceSid>requiredstring
The service SID: MG... for a Messaging Service, VA... for a Verify service.Example: MG00000000000000000000000000000001
FlagTypeDescription
--friendly-name <friendly-name>requiredstring
The name shown in the code message, e.g. "Your Shop verification code is ...".Example: Shop
--code-length <code-length>requirednumber
Digits in each code, 4 to 10.Example: 6
--fixed-code <fixed-code>string
Always send this code instead of a random one, for deterministic tests; null for random.Example: 123456
--ttl-seconds <ttl-seconds>requirednumber
How long a code stays valid, in seconds.Example: 600

Example

sendmock verify services update MG00000000000000000000000000000001 --friendly-name Shop --code-length 6 --ttl-seconds 600 --fixed-code 123456

Output with --json: VerifyService. Exit codes: 0, 1, 2, 3.

API
PATCH/api/v1/verify/services/{serviceSid}
MCP tool
sendmock_verify_service_update
In the app
SMS > Verify > Services > Edit

sendmock verify show

One verification with its code, attempts and timeline.

sendmock verify show <verificationSid>
ArgumentTypeDescription
<verificationSid>requiredstring
The verification's SID, from GET /api/v1/verify.Example: VE00000000000000000000000000000001

Example

sendmock verify show VE00000000000000000000000000000001

Output with --json: VerificationDetail. Exit codes: 0, 1, 2, 3.

API
GET/api/v1/verify/{verificationSid}
MCP tool
sendmock_verify_get
In the app
SMS > Verify > open a verification