List verification groups
Endpoints
| Endpoint | Method | Description |
|---|---|---|
/v1/verification-groups | GET | List all groups |
/v1/verification-groups/{id} | GET | Get specific group |
List All Groups
Endpoint
GET /v1/verification-groupsQuery Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | No | - | Filter: pending, approved, rejected, deleted |
phone_number_type | string | No | - | Filter: local, mobile, national |
limit | integer | No | 20 | Maximum results (1-100) |
offset | integer | No | 0 | Pagination offset |
Example Request
Example Response
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Amsterdam Office",
"phone_number_type": "local",
"status": "approved",
"locality": "Amsterdam",
"business_name": "Example BV",
"created_at": "2025-01-10T08:00:00Z"
}
],
"meta": {
"total": 1,
"limit": 10,
"offset": 0
}
}Get Group Details
Endpoint
GET /v1/verification-groups/{id}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | uuid | Yes | Verification group ID |
Example Request
Example Response
{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Amsterdam Office",
"phone_number_type": "local",
"status": "approved",
"locality": "Amsterdam",
"business_name": "Example BV",
"created_at": "2025-01-10T08:00:00Z",
"documents": [
{
"id": "doc_123",
"type": "proof_of_address",
"status": "approved"
}
],
"phone_numbers": [
{
"id": "660e8400-e29b-41d4-a716-446655440000",
"phone_number": "+31201234567",
"status": "active"
}
]
}
}Response JSON Schema (List)
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string", "format": "uuid" },
"name": { "type": "string", "nullable": true },
"phone_number_type": { "type": "string" },
"status": { "type": "string", "enum": ["pending", "approved", "rejected", "deleted"] },
"locality": { "type": "string", "nullable": true },
"business_name": { "type": "string", "nullable": true },
"created_at": { "type": "string", "format": "date-time" }
}
}
},
"meta": {
"type": "object",
"properties": {
"total": { "type": "integer" },
"limit": { "type": "integer" },
"offset": { "type": "integer" }
}
}
}
}Once your group is approved, search available numbers for that region.
Modified at 2025-12-08 10:37:25