# Check a verification code

Source: https://joinsimplesms.com/docs/api/verify/check-verification
Index: https://joinsimplesms.com/llms.txt

`POST /v1/verify/check`

The only billable moment in Verify. `charged` tells you whether this call was billed.

Send your API key as a bearer token: `Authorization: Bearer ssms_sk_...`. Test keys run this endpoint against the [sandbox](/docs/sandbox); see [Authentication](/docs/authentication) for key modes and scopes.

## Request body

JSON (`Content-Type: application/json`).

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `phone` | string | Yes |  |
| `code` | string | Yes | Example: `482193`. |

## Responses

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | Check result | JSON object |
| 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 | No active verification | `Error` |
| 429 | Rate limit or quota exceeded | `Error` |

### 200: response fields

| Field | Type | Description |
| --- | --- | --- |
| `verified` | boolean |  |
| `status` | `approved`, `pending`, `expired`, `max_attempts` |  |
| `attempts` | integer |  |
| `charged` | boolean |  |

## 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 | No active verification |
| 429 | Rate limit or quota exceeded |

Every error has the same JSON shape, and `request_id` matches the `X-Request-Id` response header. [Errors](/docs/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 POST "https://api.joinsimplesms.com/v1/verify/check" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phone": "+14155550132",
  "code": "482193"
}'
```

### Node.js

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

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

const check = await sms.verify.check({ to: '+14155550132', code: '123456' });

console.log(check.verified);
```

### Python

```python
import os
from joinsimplesms import SimpleSMS  # pip install joinsimplesms

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

check = client.verify.check("+14155550132", "123456")

print(check["verified"])
```

## Related

- Guide: [Verify](/docs/verify)
- [All verify endpoints](/docs/api#verify)
- [API reference](/docs/api)
