Update Application Information
POST /applications/{application}/info
Environment and operation
Use this endpoint contract with the account and environment assigned to your integration. Values in angle brackets are placeholders. This reference does not execute requests. Documented server https://sandbox.signup.nmi.com/api/v1 https://secure.nmi.com/api/v5/signup Schema reference: field definitions do not include every behavioral rule. Follow the workflow guidance and account prerequisites for this operation before submitting requests.
Request route
Add more information to an application that is in the `underwriter_requested_information` status. POST /applications/{application}/info Security scheme Type Credential location Scopes oauth oauth2 applications:write
Request language templates
Original transport templates derived from this endpoint’s documented method, server, authentication and media type. Replace path/query/credential placeholders with authorized sandbox values. These examples print the raw status and response; they do not infer business success or retry a request. Save one valid request variant from the fields/examples below as request.json. Do not combine mutually exclusive variants. The payload is deliberately not fabricated from schema defaults. Node requires a runtime with fetch; PHP requires cURL. Generated source-based examples have not been executed against provider accounts. curl --request POST \ --url 'https://sandbox.signup.nmi.com/api/v1/applications/{application}/info' \ --header 'Authorization: Bearer <access-token>' \ --header 'Content-Type: application/json' \ --data-binary '@request.json' import { readFile } from 'node:fs/promises'; const body = await readFile('request.json', 'utf8'); const response = await fetch("https://sandbox.signup.nmi.com/api/v1/applications/{application}/info", { method: 'POST', headers: { "Authorization": "Bearer <access-token>", "Content-Type": "application/json" }, body }); console.log(response.status, await response.text()); from urllib.request import Request, urlopen from urllib.error import HTTPError from pathlib import Path request = Request('https://sandbox.signup.nmi.com/api/v1/applications/{application}/info', method='POST', headers={'Authorization': 'Bearer <access-token>', 'Content-Type': 'application/json'}, data=Path('request.json').read_bytes()) try: with urlopen(request, timeout=30) as response: print(response.status, response.read().decode()) except HTTPError as error: print(error.code, error.read().decode()) require 'net/http' require 'uri' uri = URI("https://sandbox.signup.nmi.com/api/v1/applications/{application}/info") request = Net::HTTP::Post.new(uri) request["Authorization"] = "Bearer <access-token>" request["Content-Type"] = "application/json" request.body = File.binread('request.json') response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https', read_timeout: 30) { |http| http.request(request) } puts response.code puts response.body <?php $curl = curl_init('https://sandbox.signup.nmi.com/api/v1/applications/{application}/info'); curl_setopt_array($curl, [ CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 30, CURLOPT_HTTPHEADER => ['Authorization: Bearer <access-token>', 'Content-Type: application/json'], CURLOPT_POSTFIELDS => file_get_contents('request.json') ]); $response = curl_exec($curl); if ($response === false) { throw new RuntimeException(curl_error($curl)); } echo curl_getinfo($curl, CURLINFO_HTTP_CODE), PHP_EOL, $response; curl_close($curl);
Path and query parameters
Required flags apply to the parameter itself. Additional limits and enum values appear in the contract below. Parameter Location Required Type Description application path true See schema The ID of the application to update [ { "name": "application", "in": "path", "description": "The ID of the application to update", "required": true, "schema": { "$ref": "#/components/schemas/application-id" } } ] true
Request body
Use the declared media type: application/json. Required flags below apply within the selected object or variant. Read the workflow notes before choosing a variant. Field Type Required Description Constraints note string yes Additional information or note to be added to the application minLength: 1; maxLength: 10000 { "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": "string", "minLength": 1, "maxLength": 10000, "description": "Additional information or note to be added to the application" } }, "required": [ "note" ] }, "examples": { "success": { "summary": "Success", "description": "Add additional information to application", "value": { "note": "Additional documentation has been uploaded to support the application review process." } } } } }, "description": "Application information update payload", "required": true } true
Responses
Match the HTTP status to its response schema below. For financial operations, also inspect the payment outcome before updating your order or retrying. HTTP status Media type Meaning 200 application/json Application information updated successfully 404 application/json Error response for resource not found 422 application/json Invalid Request { "200": { "description": "Application information updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "SUCCESS", "maxLength": 100 }, "message": { "type": "string", "example": "Application information updated successfully", "maxLength": 100 } } }, "examples": { "success": { "summary": "Success", "description": "Successful information update", "value": { "code": "SUCCESS", "message": "Application information updated successfully" } } } } } }, "404": { "description": "Error response for resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code", "maxLength": 100 }, "message": { "type": "string", "description": "Error message", "maxLength": 10000 } } }, "examples": { "not-found": { "summary": "Resource Not Found", "description": "The resource cannot be found", "value": { "code": "NOT_FOUND", "message": "Resource not found" } } } } } }, "422": { "description": "Invalid Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validation-error" }, "examples": { "invalid-status": { "summary": "Invalid Application Status", "description": "Application is not in the correct status for information updates", "value": { "code": "VALIDATION_ERROR", "message": "The application information can only be updated when in the 'underwriter_requested_information' status. Current status: draft", "errors": [ "The application information can only be updated when in the 'underwriter_requested_information' status. Current status: draft" ] } }, "invalid-note": { "summary": "Invalid Note", "description": "Note field validation error", "value": { "code": "VALIDATION_ERROR", "message": "The note field is required.", "errors": [ "The note field is required." ] } } } } } } } true
Response fields · 200 · application/json
Field Type Required Description Constraints code string no maxLength: 100 message string no maxLength: 100
Response fields · 404 · application/json
Field Type Required Description Constraints code string no Error code maxLength: 100 message string no Error message maxLength: 10000
Response fields · 422 · application/json
Field Type Required Description Constraints code string no Error code maxLength: 1000 message string no Error message maxLength: 1000 errors array no
Referenced schema definitions
References beginning with #/components resolve to these definitions. These are field contracts, not example payment values. Use the applicable variant, required fields and constraints. { "securitySchemes": { "oauth": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "/oauth/token", "scopes": { "*": "Full access", "packages:read": "Read packages information", "applications:read": "Read access to applications", "applications:write": "Write access to applications", "subscriptions:read": "Read access to subscriptions", "subscriptions:write": "Write access to subscriptions (subscribe/updated/delete)" } } } } }, "schemas": { "application-id": { "type": "string", "description": "The unique identifier of the application.", "pattern": "^app_[a-f0-9]{16}$", "minLength": 20, "maxLength": 20 }, "validation-error": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code", "maxLength": 1000 }, "message": { "type": "string", "description": "Error message", "maxLength": 1000 }, "errors": { "type": "array", "maxItems": 10, "items": { "type": "string", "description": "The error message", "maxLength": 1000 } } } }, "event-types": { "type": "string", "enum": [ "application.updated.data.requested", "application.approved", "application.declined", "application.cancelled", "application.merchant.closed", "application.merchant.boarded", "merchant.chargeback.added", "merchant.deposit.new", "merchant.first-batch", "merchant.processing.start", "merchant.processing.stop", "merchant.residuals.published", "merchant.retrieval.added", "merchant.statement.new" ], "example": "application.merchant.boarded" } }, "responses": { "error-not-found": { "description": "Error response for resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code", "maxLength": 100 }, "message": { "type": "string", "description": "Error message", "maxLength": 10000 } } }, "examples": { "not-found": { "summary": "Resource Not Found", "description": "The resource cannot be found", "value": { "code": "NOT_FOUND", "message": "Resource not found" } } } } } } } } true
Integration checks
Validate the request against its selected schema before submission. Keep secrets outside browser code. Test permitted and denied account access, validation failures and interrupted responses in the sandbox. Account-management or messaging operations require the corresponding partner access and intended recipient context.