/v2/application/business/createCreate Business Plus Application
Creates an empty Business Plus application and returns its id. Use that id on every later call.
Call Get Business 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 Business Plus Application again to review those values, then call Update Business Plus Application to complete the form. Type defaults to 1.
Headers
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
session-token | string | Required | — | SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header. |
Request body
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
Email | string | Required | — | Primary individual email. An empty primary individual is created with this email. The email is required and must not already be in use. |
BrokerReferenceId | string | Optional | — | Optional broker-side reference. It is echoed on webhooks and the detail response. |
Type | integer | Optional | 1 | Business Plus application type. Defaults to 1. |
Response
| Field | Type | Possible values | Description |
|---|---|---|---|
ResponseCode | integer | 200 | 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). |
ResponseMessage | string | Success | 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. |
ResponseData | object | Please refer to below example for response body | Created application identifiers. |
Example response
{
"ResponseCode": 200,
"ResponseMessage": "Success",
"ResponseData": {
"ApplicationId": "6a3a2f324c2e4b093dce834b",
"ApplicationNo": "BP-260624-A"
}
}Save ApplicationId. Use it on Get Business Plus Application, Upload Document, and Update Business Plus Application.
Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.