POST/simulate/form-status

Simulate Form Status

Simulates an application/form status change and fires the corresponding broker webhook event.

Triggers one of: form.incomplete, form.approved, or form.rejected — based on the Status value sent.

The Id field accepts the ApplicationId (also referred to as FormId) returned from the submit-form response.

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
`Id`	string	Required	—	Application ID (same as `ApplicationId` from submit-form).
`Status`	integer	Required	2 (missing/incomplete) \| 3 (approved) \| 4 (rejected)	Target form status code.
`Remark`	string	Optional	—	Optional remark included in the webhook payload.

Example request

{
  "Id": "6a4763a25f39cb7aee21f0e3",
  "Status": 3,
  "Remark": "All documents verified."
}

{
  "Id": "6a4763a25f39cb7aee21f0e3",
  "Status": 3,
  "Remark": "All documents verified."
}

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	The updated business object after the status change.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Version": 2,
    "ApplicationId": "6a4763a25f39cb7aee21f0e3",
    "EntityType": "Limited_Liability_Company",
    "BusinessName": "Example Broker Managed LLC",
    "AmountOfInitialDeposit": 10000
  }
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Version": 2,
    "ApplicationId": "6a4763a25f39cb7aee21f0e3",
    "EntityType": "Limited_Liability_Company",
    "BusinessName": "Example Broker Managed LLC",
    "AmountOfInitialDeposit": 10000
  }
}

Fires exactly one webhook event: `form.incomplete` for status 2, `form.approved` for status 3, `form.rejected` for status 4.

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