Retrieve a verification

GET /v1/verify/{id}

Send your API key as a bearer token: Authorization: Bearer ssms_sk_.... Test keys run this endpoint against the sandbox; see Authentication for key modes and scopes.

Path parameters

Name	Type	Required	Description
`id`	string	Yes

Responses

Status	Meaning	Body
200	The verification	`Verification`
401	Missing, malformed, or revoked API key	`Error`
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged	`Error`
404	Not found	`Error`
429	Rate limit or quota exceeded	`Error`

200: `Verification` fields

Field	Type	Description
`id`	string	Example: `ver_a1B2c3D4e5F6g7H8`.
`object`	`verification`
`phone`	string
`status`	`pending`, `approved`, `expired`, `max_attempts`, `blocked`
`attempts`	integer
`test`	boolean
`charged`	boolean
`created_at`	string (date-time)
`expires_at`	string (date-time)
`customer_id`	string	The customer this is attributed to. Present only when set.

Errors

Status	When
401	Missing, malformed, or revoked API key
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
404	Not found
429	Rate limit or quota exceeded

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

json

{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}

Examples

curl

bash

curl -X GET "https://api.joinsimplesms.com/v1/verify/ver_a1B2c3D4e5F6g7H8" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY"

Node.js

javascript

import { SimpleSMS } from 'joinsimplesms'; // npm install joinsimplesms

const sms = new SimpleSMS(process.env.SIMPLESMS_API_KEY);

const verification = await sms.verify.get('ver_a1B2c3D4e5F6g7H8');

console.log(verification.status);

Python

python

import os
from joinsimplesms import SimpleSMS  # pip install joinsimplesms

client = SimpleSMS(os.environ["SIMPLESMS_API_KEY"])

verification = client.verify.get("ver_a1B2c3D4e5F6g7H8")

print(verification["status"])