verify
verify — 2 operations (POST /v1/apps/{appId}/verify/sms, POST /v1/apps/{appId}/verify/sms/check). Generated from the OpenAPI 3.1.0 contract.
Base URL: https://api.pushizo.com · Tag: verify · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
POST | /v1/apps/{appId}/verify/sms | Send an SMS verification code |
POST | /v1/apps/{appId}/verify/sms/check | Check an SMS verification code |
Details
Send an SMS verification code
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: StartVerifyDto
| Field | Type | Required | Description |
|---|---|---|---|
phone | string | Yes | Length: 8–20 |
locale | string | No | Length: 2–12 |
Example:
{
"phone": "+905321234567",
"locale": "tr"
}Responses
201 — Success.
Schema: SmsVerification
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
expires_at | string | Yes |
Example response:
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"expires_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/verify/sms" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"phone": "+905321234567",
"locale": "tr"
}'Check an SMS verification code
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CheckVerifyDto
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Length: 4–80 |
code | string | Yes |
Example:
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"code": "değer"
}Responses
200 — Success.
Schema: SmsVerificationCheck
| Field | Type | Required | Description |
|---|---|---|---|
verified | true | Yes |
Example response:
{
"verified": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/verify/sms/check" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"code": "değer"
}'