Folders

Endpoints for managing verification folders

Get Folders

get

Get all folders for the authenticated creator.

This endpoint returns all folders created by the authenticated creator.

Authorizations

APIKeyHeader

X-API-KeystringRequired

API key for authentication. Can be obtained from the creator dashboard.

cookie

session_idany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/creator/folders

HTTPcURLJavaScriptPython

GET /creator/folders HTTP/1.1
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Create Folder

post

Create a new folder for organizing verifications.

This endpoint allows creators to create folders for organizing their verifications. Folders can have custom fields that will be collected for all verifications in the folder.

• name: The name of the folder

• description: A description of the folder

• custom_fields: Array of custom fields to collect for all verifications in this folder

Authorizations

APIKeyHeader

X-API-KeystringRequired

API key for authentication. Can be obtained from the creator dashboard.

cookie

session_idany ofOptional

stringOptional

or

nullOptional

Body

application/json

namestringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

custom_fieldsany ofOptionalDefault: []

object[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/creator/folders

HTTPcURLJavaScriptPython

POST /creator/folders HTTP/1.1
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "name": "text",
  "description": "text",
  "custom_fields": [
    {}
  ]
}

No content

Get Folder

get

Get a specific folder by ID.

This endpoint returns details about a specific folder, including its custom fields.

• folder_id: The ID of the folder to retrieve

Authorizations

APIKeyHeader

X-API-KeystringRequired

API key for authentication. Can be obtained from the creator dashboard.

cookie

session_idany ofOptional

stringOptional

or

nullOptional

Path parameters

folder_idstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/creator/folders/{folder_id}

HTTPcURLJavaScriptPython

GET /creator/folders/{folder_id} HTTP/1.1
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Delete Folder

delete

Delete a folder.

This endpoint allows creators to delete a folder that they created. All verifications associated with this folder will also be deleted.

• folder_id: The ID of the folder to delete

Authorizations

APIKeyHeader

X-API-KeystringRequired

API key for authentication. Can be obtained from the creator dashboard.

cookie

session_idany ofOptional

stringOptional

or

nullOptional

Path parameters

folder_idstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/creator/folders/{folder_id}

HTTPcURLJavaScriptPython

DELETE /creator/folders/{folder_id} HTTP/1.1
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Get Folder Verifications

get

Get all verifications for a specific folder.

This endpoint returns all verifications associated with a specific folder.

• folder_id: The ID of the folder to retrieve verifications for

Authorizations

APIKeyHeader

X-API-KeystringRequired

API key for authentication. Can be obtained from the creator dashboard.

cookie

session_idany ofOptional

stringOptional

or

nullOptional

Path parameters

folder_idstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/creator/folders/{folder_id}/verifications

HTTPcURLJavaScriptPython

GET /creator/folders/{folder_id}/verifications HTTP/1.1
X-API-Key: YOUR_API_KEY
Accept: */*

No content