Sign in

v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
Onboarding

Respond to an associated person information request item

Submits a response to a specific required information item on an information request for an associated person.

post/applications/{applicationId}/information-requests/{informationRequestId}/associated-people/{associatedPersonId}/respond

Path parameters

applicationIdstring uuid required

The ID of the application to work with.

Example:e9293471-5eb3-4dbc-916c-dbaf9e2deefd
informationRequestIdstring uuid required

The ID of the information request to respond to.

Example:e9293471-5eb3-4dbc-916c-dbaf9e2deefd
associatedPersonIdstring uuid required

The ID of the associated person to work with.

Example:e9293471-5eb3-4dbc-916c-dbaf9e2deefd

Request body

codestring required

The code identifying which required information item to respond to.

responsestring required

The response value. Format is validated server-side according to the expected response type.

notApplicableboolean

Set to true if you are unable to provide the requested item. When set, response must contain a free-text explanation of why, and is accepted regardless of the expected response type. Defaults to false when omitted.

Example request

{
  "code": "PROOF_OF_ADDRESS",
  "response": "We process approximately 500 transactions per month.",
  "notApplicable": false
}

Response

OK

codestring required

The code of the information item that was responded to.

responsestring required

The response value. Format is validated server-side according to the expected response type.

notApplicableboolean

Whether the customer indicated they are unable to provide the requested item, with the reason in response.

createdAtstring date-time required

The date the Resource was initially created. ISO 8601 format without milliseconds.

idstring uuid required

The ID of the information request response.

informationRequestIdstring uuid required

The ID of the information request to respond to.

Example response

{
  "code": "string",
  "response": "We process approximately 500 transactions per month.",
  "notApplicable": false,
  "createdAt": "2019-08-24T14:15:22Z",
  "id": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
  "informationRequestId": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd"
}