POST/simulate/document-status

Simulate Document Status

Simulates a document status change and fires the corresponding webhook (document.incomplete, document.approved, or document.rejected).

The Id is the document record ID — found in Documents[].RecordId from GET /application/detail/{id}.

Blocked in production. Returns 400 when simulation is disabled.

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.

Field	Type	Required	Possible values	Description
`Id`	string	Required	—	Document record ID. Copy from `Documents[].RecordId` in the application detail response.
`Status`	integer	Required	2 (incomplete) \| 3 (approved) \| 4 (rejected)	Target document status.
`Remark`	string	Optional	—	Optional remark. Included in the webhook payload and shown in the action item when status is `incomplete`.

Example request

{
  "Id": "6a478fe57267551942867f7d",
  "Status": 4,
  "Remark": "Document is illegible."
}

{
  "Id": "6a478fe57267551942867f7d",
  "Status": 4,
  "Remark": "Document is illegible."
}

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	`DocumentId` — the document that was updated. `Status` — the new status code.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "DocumentId": "6a478fe57267551942867f7d",
    "Status": 4
  }
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "DocumentId": "6a478fe57267551942867f7d",
    "Status": 4
  }
}

A 400 with `record_not_found` is returned if the document ID does not exist.

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