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

Start a CHESS-coupled client (domestic facility) mailing address change. Submits an MT203 registration details update with an Update Client Mailing Address task; the client's postal address is only applied — with client audit and diary — after ASX authorises via MT220.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Unique client identifier.	integer	Required

Body Parameters

New structured mailing address and submit options.

ClientMailingAddressChessUpdate

Name	Description	Type	Additional information
MailingAddress	New structured mailing address for the facility	ClientChessMailingAddress	Required
RegistrationDetailsStrategy	How the CHESS registration details (MT203 B59) are produced. Only RebuildFromMailingAndExistingName is supported (default when omitted).	string	None.
RegistrationDetails	Caller-supplied registration detail lines. Not supported in v1 — must be omitted.	Collection of string	None.
UpdatePersonMailingAddress	Also update account holders' person mailing addresses. Not supported in v1 — must be false.	boolean	None.
UpdatePersonResidentialAddress	Also update account holders' person residential addresses. Not supported in v1 — must be false.	boolean	None.
CorrelationId	Workflow correlation id; echoed on the response and recorded on the CHESS task	string	String length: inclusive between 0 and 100
ActorPersonID	Initiating person id; used as the task creator and client diary actor	integer	None.
InitiatedVia	Initiation source (e.g. "Self Service"); recorded on the CHESS task and repeated in the client diary and audit trail entries written when ASX applies or rejects the change	string	String length: inclusive between 0 and 50
MfaChannel	MFA channel used for the step-up challenge (e.g. "SMS", "TOTP"); optional	string	String length: inclusive between 0 and 30

Request Formats

application/json, text/json

Sample:

{
  "MailingAddress": {
    "Line1": "1 COLLINS ST",
    "Line2": null,
    "Suburb": "MELBOURNE",
    "State": "VIC",
    "Postcode": "3000",
    "Country": "AUSTRALIA"
  },
  "RegistrationDetailsStrategy": "RebuildFromMailingAndExistingName",
  "RegistrationDetails": null,
  "UpdatePersonMailingAddress": false,
  "UpdatePersonResidentialAddress": false,
  "CorrelationId": "ferrari-wf-change-address-FAC-1001-abc",
  "ActorPersonID": 12345,
  "InitiatedVia": "Self Service",
  "MfaChannel": "SMS"
}

application/xml, text/xml

Sample:

<ClientMailingAddressChessUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account">
  <ActorPersonID>12345</ActorPersonID>
  <CorrelationId>ferrari-wf-change-address-FAC-1001-abc</CorrelationId>
  <InitiatedVia>Self Service</InitiatedVia>
  <MailingAddress>
    <Country>AUSTRALIA</Country>
    <Line1>1 COLLINS ST</Line1>
    <Line2 i:nil="true" />
    <Postcode>3000</Postcode>
    <State>VIC</State>
    <Suburb>MELBOURNE</Suburb>
  </MailingAddress>
  <MfaChannel>SMS</MfaChannel>
  <RegistrationDetails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <RegistrationDetailsStrategy>RebuildFromMailingAndExistingName</RegistrationDetailsStrategy>
  <UpdatePersonMailingAddress>false</UpdatePersonMailingAddress>
  <UpdatePersonResidentialAddress>false</UpdatePersonResidentialAddress>
</ClientMailingAddressChessUpdate>

Response Information

Resource Description

ClientMailingAddressChessUpdateResult

Name	Description	Type	Additional information
ClientID	Client (domestic facility) id	integer	None.
HIN	Holder Identification Number the update was submitted for	decimal number	None.
ChessUpdateDetailsTaskID	Id of the created CHESSUpdateDetailsTask (type Update Client Mailing Address) — use for status polling	integer	None.
ChessMessageID	Id of the outbound MT203 CHESS message	integer	None.
TransactionID	CHESS transaction id (B48) of the outbound MT203	string	None.
Status	Task status after submit (InProgress)	string	None.
CorrelationId	Echo of the caller-supplied correlation id	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ClientID": 1001,
  "HIN": 12345678901.0,
  "ChessUpdateDetailsTaskID": 98765,
  "ChessMessageID": 54321,
  "TransactionID": "0000012345678900",
  "Status": "InProgress",
  "CorrelationId": "ferrari-wf-change-address-FAC-1001-abc"
}

application/xml, text/xml

Sample:

<ClientMailingAddressChessUpdateResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account">
  <ChessMessageID>54321</ChessMessageID>
  <ChessUpdateDetailsTaskID>98765</ChessUpdateDetailsTaskID>
  <ClientID>1001</ClientID>
  <CorrelationId>ferrari-wf-change-address-FAC-1001-abc</CorrelationId>
  <HIN>12345678901</HIN>
  <Status>InProgress</Status>
  <TransactionID>0000012345678900</TransactionID>
</ClientMailingAddressChessUpdateResult>

Error Response Information

Resource Description

BadRequestResult

Name	Description	Type	Additional information
Errors		Collection of Error	None.

Error Response Formats

application/json, text/json

Sample:

{
  "Errors": [
    {
      "Code": 13000,
      "Description": "sample string 1"
    },
    {
      "Code": 13000,
      "Description": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<BadRequestResultOfenClientMailingAddressChessUpdateErrorYd1IcMMv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.ErrorResponse">
  <Errors>
    <ErrorOfenClientMailingAddressChessUpdateErrorYd1IcMMv>
      <Code>InvalidRequest</Code>
      <Description>sample string 1</Description>
    </ErrorOfenClientMailingAddressChessUpdateErrorYd1IcMMv>
    <ErrorOfenClientMailingAddressChessUpdateErrorYd1IcMMv>
      <Code>InvalidRequest</Code>
      <Description>sample string 1</Description>
    </ErrorOfenClientMailingAddressChessUpdateErrorYd1IcMMv>
  </Errors>
</BadRequestResultOfenClientMailingAddressChessUpdateErrorYd1IcMMv>