API Overview

The Colleckt REST API allows you to programmatically create and manage identity verifications, upload documents, make decisions, and configure webhooks.

Base URL

https://{workspace}.colleckt.io/api/v1/{flow}

Variable	Description	Example
{workspace}	Your workspace name	acme
{flow}	The flow path name	usps1583

Workspace Patterns

• Production: https://acme.colleckt.io/api/v1/usps1583/...
• Sandbox: https://acme-sandbox.colleckt.io/api/v1/usps1583/...

Versioning

The API is versioned via the URL path prefix:

• Current version: v1
• Breaking changes will result in a new version (e.g., v2)
• Backward-compatible additions may be added within v1
• The version is mandatory in the URL path

Content Type

All API requests and responses use JSON format.

Set the Content-Type header:

Content-Type: application/json

Authentication

All API endpoints require authentication via a Bearer token:

Authorization: Bearer {your_api_token}

See the API Authentication section for details on obtaining and using tokens.

Conventions

Response Wrapper

All responses are wrapped in a data object:

{
  "data": { ... }
}

List responses also include links and meta objects for pagination:

{
  "data": [ ... ],
  "links": {
    "first": "...",
    "last": "...",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "...",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}

Date/Time Format

All timestamps use ISO 8601 format:

2026-06-11T07:36:42.000000Z

Country Codes

Countries are identified using ISO 3166-1 alpha-3 codes (e.g., USA, GBR, CAN).

Document Types

Documents are categorized using context type codes:

Type	Value	Description
Photo ID	1	Government-issued photo identification
Proof of Address	2	Address verification document
Selfie	3	Live selfie capture

Available Flows

The API is scoped to a flow, which determines the verification process configuration:

Flow Path	Description
usps1583	USPS Form 1583 identity verification for virtual address providers
identity	General identity verification

Pagination

List endpoints return paginated results with:

• Default page size: 15 items
• Use the page query parameter to navigate pages
• The response includes links (first, last, prev, next) and meta (current_page, last_page, per_page, total, from, to)

HTTP Methods

Method	CRUD	Idempotent
GET	Read	Yes
POST	Create	No
PATCH	Partial update	Yes
PUT	Full update / action	Yes
DELETE	Delete	Yes

Related Resources

• API Authentication
• Error Handling
• Rate Limiting
• Data Models
• API Playground