Sign in

v1

latestOpenAPI 3.1.02026-07-261520561.4 KB
Additional Person

List Additional Person Applications

get/apply/additional_person_application

Query parameters

account_idstring

ID of the Account to add an additional person. Filterable.

person_application_idstring

ID of the Person Application to associate with the Account. Filterable.

rolestring

Role to use when associating the Person Application with the Account. Filterable.

statusstring

Status of the additional person application. One of approved, error, pending, processing, rejected, manual_review. 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 additional-person-application elements, starting after the additional-person-application described by page_cursor. If no more additional-person-applications are available, the resulting list will be empty.