Skip to main content
GET
/
events
List Events
curl --request GET \
  --url https://api.paxos.com/v2/events \
  --header 'Authorization: Bearer <token>'
{
  "events": [
    {
      "id": "d99a03ee-6b88-4362-89da-087c2c8cd4a7",
      "type": "identity.approved",
      "object_type": "identity_summary_status_change",
      "object": {
        "id": "d840cf31-352f-4190-a476-7522bf3eafda",
        "identity_id": "4fd025ab-f29f-47e6-a02e-df90a61c7ec9",
        "new_summary_status": "APPROVED",
        "old_summary_status": "PENDING"
      },
      "created_at": "2023-08-25T14:25:41.648489333Z",
      "undelivered_webhooks": 0
    },
    {
      "id": "19c0ae8e-fdfc-4b27-88af-07762af8f2a8",
      "type": "identity.documents_required",
      "object_type": "identity_required_documents",
      "object": {
        "id": "d11aba88-39cd-4445-acbb-e4d127588def",
        "identity_id": "fc9dcae4-5411-464c-a20e-f0911ee1c5c1",
        "required_documents": [
          "TAX_IDENTIFICATION",
          "PROOF_OF_RESIDENCY",
          "PROOF_OF_FUNDS"
        ]
      },
      "created_at": "2023-08-24T18:29:41.648489493Z",
      "undelivered_webhooks": 0
    }
  ]
}
OAuth Scope
events:read_event

Authorizations

​
Authorization
string
header
required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

Learn more in the API credentials guide →

Query Parameters

​
created_at.lt
string<date-time>

Include timestamps strictly less than lt. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.lte
string<date-time>

Include timestamps less than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.eq
string<date-time>

Include timestamps exactly equal to eq. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.gte
string<date-time>

Include timestamps greater than or equal to gte. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.gt
string<date-time>

Include timestamps strictly greater than gt. RFC3339 format, like 2006-01-02T15:04:05Z.

​
limit
integer<int32>

Number of results to return. Defaults to 100 if no limit is provided.

​
type
string

Retrieve all (default) or optionally filter by event type.

​
is_test
boolean

Filter for test events (true) or real events (false). Defaults to false (real events only).

​
order
enum<string>

Sort order for results by created_at. Defaults to ASC (oldest first).

Available options:
DESC,
ASC
​
page_cursor
string

Cursor from a previous response to fetch the next page.

Response

Success

​
events
object[]

Events ordered by created_at timestamp in the direction specified by the order parameter (ascending by default).

​
next_page_cursor
string

Cursor to pass in the next request to fetch the next page. Empty when no more results.