v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

Applicants

Send Document Rejection Notification

Notify an applicant that a compliance document submission was rejected. Sends email (and SMS when the applicant has a phone number) through the account messaging settings.

post/v2/applicants/{id}/document_rejection_notifications

Path parameters

idstring required

Request body

document_type_namestring required

Name of the rejected document type, shown to the applicant

rejection_reasonsstring[]

Rejection reason codes selected by the reviewer (e.g. DOCUMENT_EXPIRED)

custom_rejection_reasonstring

Free-text reason provided by the reviewer for the OTHER reason code

messagestring

Reviewer-edited notification body; when omitted, a default message is composed from the rejection reasons

Response

Created

messagestring required

Successful notification queued message