increase-test
GET/entity_supplemental_documents

List entity supplemental document submissions

Lists supplemental documents submitted for an entity during onboarding. Supply entity_id to select the entity, and use cursor to continue through the results or idempotency_key to filter for a specific submission.

4 parameters
cursorstringoptional
Returns the page of supplemental document submissions after this cursor.
limitintegeroptional
Maximum number of submissions to return. Must be between 1 and 100. Defaults to 100 when omitted.
Default:100
entity_idstringrequired
The identifier of the entity whose supplemental document submissions to list.
idempotency_keystringoptional
Filter for the submission with this idempotency key. Must be between 1 and 200 characters.

3 status codes
200Returns a page of supplemental document objects and a `next_cursor` for retrieving the next page.
dataarray<SupplementalDocument>required
The contents of the list.
next_cursorstringrequired
A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.
4XXReturned when the request has a client-side error.
5XXReturned when the request encounters a server-side error.

Error handling

entity_id is required. limit must be between 1 and 100, and idempotency_key must be between 1 and 200 characters when provided.