NMnmi
Applications

Upload Document

Provide supporting documents for the application. Documents can only be uploaded while the application is the draft or underwriter_requested_information status.

Required scope: applications:write

post/applications/{application}/documents

Request

  • Base URL
    https://sandbox.signup.nmi.com/api/v1
  • URL
    https://sandbox.signup.nmi.com/api/v1/applications/{application}/documents
  • Auth
    OAuth 2
    Client credentials
    Token URL: /oauth/token scopes: applications:write

Path parameters

applicationstring required

The unique identifier of the application.

The ID of the application to provide document

Headers

Idempotency-Keystring

Provide a random key (for example, UUID) to make the request idempotent

Request body multipart/form-data

type'Void Check' | 'Marketing Materials' | '3 Months of Statements' | 'Driver License' | 'SSN Card' | 'Form SS4' | 'Other' required

The type of the document

filestring binary required

The document to upload (accepted formats: image/png, image/jpg, image/jpeg, application/pdf, max filesize 20 MB)

Response

Document uploaded successfully

idstring required

The unique identifier of the document.

application_idstring required

The unique identifier of the application.

type'Void Check' | 'Marketing Materials' | '3 Months of Statements' | 'Driver License' | 'SSN Card' | 'Form SS4' | 'Other' required

The type of the document

file_namestring required
status'draft' | 'submitted' required

The status of the document

created_atstring date-time required

The date and time when was created.

updated_atstring date-time required

The date and time when was last updated.

Example response

{
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.