POST/v2/application/individual/create

Create Individual Plus Application

Creates an empty Individual Plus application and returns its id. Use that id on every later call.

Call Get Individual Plus Application to see which documents are required, then upload them with Upload Document. Documents flagged needForFormExtraction are read automatically and used to pre-fill the form. Call Get Individual Plus Application again to review those values, then call Update Individual Plus Application to complete the form.

Headers

FieldTypeRequiredPossible valuesDescription
session-tokenstringRequired—

SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Request body

FieldTypeRequiredPossible valuesDescription
EmailstringRequired—

Individual email. Required to create, and immutable afterwards. Must not already be in use.

BrokerReferenceIdstringOptional—

Optional broker-side reference. It is echoed on webhooks and the detail response.

Response

FieldTypePossible valuesDescription
ResponseCodeinteger200 | 201 | 204 | 301 | 400 | 401 | 403 | 404 | 410 | 422 | 500 | 503

API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).

ResponseMessagestringSuccess | Created | NoContent | BadRequest | Unauthorized | Forbidden | NotFound | Gone | UnprocessableContent | ServerError | ResourceMoved | ServiceUnAvailable | UnProcessableEntity

Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.

ResponseDataobjectPlease refer to below example for response body

Created application identifiers.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "ApplicationId": "6a3a2f324c2e4b093dce834b",
    "ApplicationNo": "IP-260624-A"
  }
}

Save ApplicationId. Use it on Get Individual Plus Application, Upload Document, and Update Individual Plus Application.

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.

Search guide books, endpoints, paths, or parameters

↑↓navigate↵openEscclose