Sign in

v1

latestOpenAPI 3.1.02026-07-261520561.4 KB
Person Application

List Person Applications

get/apply/person_application

Query parameters

person_idstring

ID of the person object created as a result of a successful account application. Filterable.

page_cursorstring

Pagination cursor, value is the object ID.

page_sizeinteger

Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.

from_datestring

Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).

to_datestring

Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).

Response

A dictionary with a data property that contains a list of up to page_size person-application elements, starting after the person-application described by page_cursor. If no more person-applications are available, the resulting list will be empty.