NMnmi
Applications

Create a new application

In the Sandbox environment, the application's status is determined by the Monthly Volume Field (fld_monthly_volume).

Based on this value, the system will send one of the following webhook events:

Pending

  • Webhook event: application.updated.data.requested
  • Monthly volume is greater than or equal to $100,000

Approved

  • Webhook event: application.approved
  • Monthly volume is between $5,000 and $99,999

Declined

  • Webhook event: application.declined
  • Monthly volume is less than $5,000

Required scope: applications:write

post/applications

Request

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

Headers

Idempotency-Keystring

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

Request body

package_idstring required

The unique identifier of the package.

Example request

{
  "package_id": "pkg_merrick_tsys"
}

Response

Application created successfully

idstring required

The unique identifier of the application.

package_idstring required

The unique identifier of the package.

status'draft' | 'submitted' | 'approved' | 'rejected' | 'underwriter_requested_information' | 'requested_information_sent' | 'boarded' required
created_atstring date-time required

The date and time when the application was created.

updated_atstring date-time required

The date and time when the application was last updated.

Example response

{
  "package_id": "pkg_merrick_tsys",
  "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.