Skip to main content
GET
List onboarding proofs

Authorizations

x-api-key
string
header
required

API key created in Dashboard → Settings → Developer

Query Parameters

scope
enum<string>
default:company

Choose the data scope. company (default) limits results to the API key company's data. agency includes the parent agency and its linked brands. scope=agency requires a parent agency key; other keys receive 403.

Available options:
company,
agency
programId
string<uuid>
required
status
enum<string>
default:pending_review
Available options:
pending_review,
approved,
rejected
type
enum<string>

Optional. Both types when absent.

Available options:
account_requirement,
warm_up
creatorId
string

Optional opaque creator id

creatorHandle
string

Limit results to creators who have a linked social account with exactly this handle, in any letter case. A leading @ is ignored. A handle that no visible creator linked returns an empty result. Use it when you know the handle but not the creatorId.

page
integer
default:1
Required range: x >= 1
limit
integer
default:25
Required range: 1 <= x <= 100

Response

Proofs returned successfully

data
object[]
required
page
integer
required
total
integer
required
totalPages
integer
required