Skip to main content
GET
List document addresses

Authorizations

X-Api-Key
string
header
required

API key for authentication. Access https://console.beltic.com/ to obtain your API key.

Query Parameters

page[size]
string

Number of items per page (default: 15)

Pattern: ^\d+$
Example:

"15"

page[after]
string

Cursor for fetching items after this point

Example:

"eyJ2YWx1ZXMiOnsiY3JlYXRlZF9hdCI6IjIwMjUtMTAtMjJUMjI6MTM6NDguMTQ5WiJ9LCJpZCI6IjNkZjk3MWQwLWNkNTYtNDAwNi05YmM0LTFjYmMzMjc1OWI2ZiJ9"

page[before]
string

Cursor for fetching items before this point

Example:

"eyJ2YWx1ZXMiOnsiY3JlYXRlZF9hdCI6IjIwMjUtMTAtMjJUMjI6MTM6NDguMTQ5WiJ9LCJpZCI6IjNkZjk3MWQwLWNkNTYtNDAwNi05YmM0LTFjYmMzMjc1OWI2ZiJ9"

page[total]
enum<string>

Include total count in response (may impact performance)

Available options:
true,
false
Example:

"true"

account_id
string<uuid>

Filter documents by account ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

session_id
string<uuid>

Filter documents by session ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

status
enum<string>

Filter documents by status

Available options:
pending,
submitted,
processed,
failed
Example:

"pending"

Response

Successfully retrieved documents

data
object[]
required
meta
object
required