Skip to main content
GET
List onboarding documents

Authorizations

x-api-key
string
header
required

Company API key for authentication

Path Parameters

merchantId
string
required

The merchant ID

Query Parameters

page
integer
default:1

Page number for pagination

Required range: x >= 1
limit
integer
default:20

Number of documents per page

Required range: 1 <= x <= 100
company_id
string

Filter by the company the document was presented for

subject_document_number
string

Filter by the subject's document number (CPF or CNPJ); punctuation is ignored

sort
enum<string>[]

Sort string (e.g., -created_at). Allowed field: created_at. Defaults to -created_at.

Available options:
created_at,
-created_at

Response

Paginated list of onboarding documents

Paginated list of onboarding documents

data
object[]
required
pagination
object
required