GET/v2/application/individual/detail/{id}

Get Individual Plus Application

Returns the full Individual Plus application, including anything still required to complete it.

Path variables

FieldTypeRequiredPossible valuesDescription
idstringRequired—

Application ID returned by Create Individual Plus Application.

Headers

FieldTypeRequiredPossible valuesDescription
session-tokenstringRequired—

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

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

Full Individual Plus application and anything still needed to complete it. `ApplicationType` is `INDIVIDUAL_PLUS`.

ApplicationState.Statestring (enum)missing | submitted | approved | rejected | draft

Current state of the application.

Example response

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

If the application ID does not exist or does not belong to the authenticated broker, a 400 response is returned with code `record_not_found`.

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

Search guide books, endpoints, paths, or parameters

↑↓navigate↵openEscclose