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
X-API-KeystringRequired

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

cookie
session_idany ofOptional
stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
get
/creator/folders

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
X-API-KeystringRequired

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

cookie
session_idany ofOptional
stringOptional
or
nullOptional
Body
namestringRequired
descriptionany ofOptional
stringOptional
or
nullOptional
custom_fieldsany ofOptionalDefault: []
object[]Optional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/creator/folders

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
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
chevron-right
200

Successful Response

application/json
Responseany
get
/creator/folders/{folder_id}

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
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
chevron-right
200

Successful Response

application/json
Responseany
delete
/creator/folders/{folder_id}

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
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
chevron-right
200

Successful Response

application/json
Responseany
get
/creator/folders/{folder_id}/verifications

No content

Last updated