GET api/bfg/v1/accounts/{clientId}/mailing-address-chess-updates/{taskId}

Get the status of a CHESS-coupled client mailing address change task, for workflow polling.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Unique client identifier.	integer	Required
taskId	CHESS update details task id returned by the submit.	integer	Required

Body Parameters

None.

Response Information

Resource Description

ClientMailingAddressChessUpdateStatus

Name	Description	Type	Additional information
ClientID	Client (domestic facility) id	integer	None.
ChessUpdateDetailsTaskID	CHESSUpdateDetailsTask id	integer	None.
Status	Task status: New \| InProgress \| Completed \| Failed \| Cancelled \| Rejected \| Pending \| MessageSent	string	None.
RejectedReason	ASX rejection reason when the task failed (MT518/MT540)	string	None.
TransactionID	CHESS transaction id (B48) of the outbound MT203	string	None.
PostalAddressID	The client's postal address id once the change has been applied (Completed only)	integer	None.
DateCreated	When the task was created	date	None.
DateUpdated	When the task was last updated	date	None.

Response Formats

application/json, text/json

Sample:

{
  "ClientID": 1001,
  "ChessUpdateDetailsTaskID": 98765,
  "Status": "Completed",
  "RejectedReason": null,
  "TransactionID": "0000012345678900",
  "PostalAddressID": 555,
  "DateCreated": "2026-08-07T10:00:00",
  "DateUpdated": "2026-08-07T14:30:00"
}

application/xml, text/xml

Sample:

<ClientMailingAddressChessUpdateStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account">
  <ChessUpdateDetailsTaskID>98765</ChessUpdateDetailsTaskID>
  <ClientID>1001</ClientID>
  <DateCreated>2026-08-07T10:00:00</DateCreated>
  <DateUpdated>2026-08-07T14:30:00</DateUpdated>
  <PostalAddressID>555</PostalAddressID>
  <RejectedReason i:nil="true" />
  <Status>Completed</Status>
  <TransactionID>0000012345678900</TransactionID>
</ClientMailingAddressChessUpdateStatus>