Customer Demographics

Customers

Customer Demographics

User-friendly and convenient method for customers to update their demographic details including their correspondence address, email address and phone number.

Australia

Customers can update their contact details

Customers can update their contact details anytime from the third-party site.
Zoom In

Secure identification

Customers can log in to Citi securely with their Citi user ID and password. 

 

Refer to the API callout for information about retrieving an authorization code.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Authorization code grant: Retrieve authorization code

This API is invoked by a web browser redirection and requires user interaction. It is used to retrieve an authorization code by redirecting the user to a login page followed by the consent approval page. At the end of this flow, this endpoint returns to the redirect_uri configured for the associated application.

Endpoint

Australia: GET /authCode/oauth2/authorize

Parameters

PATH

NA

Query

response_type

client_id

scope

countryCode

businessCode

locale

state

redirect_uri

Customer consent

Customers can authorize Citi to share their data with third-party providers that they trust by clicking on 'Authorize'. After successful authorization, an access token is issued to the third party.

Zoom In

Customers validate the one-time password sent to their registered mobile number

Consenting customers can receive a one-time password from Citi on their registered mobile number and then validate it. In the three-legged OAuth flow, one-time password validation is based on a fraud and risk recommendation, but is not mandatory.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Authorization code grant: Retrieve access token

Get an access token issued by calling our token endpoint and passing the authorization code from the previous call. The issued access token will expire, and will be valid only for the scope for which the consent has been provided by the customer. You can call the APIs by passing this token in the authorization header.


You also get a refresh token that can be used to get a new access token in case the original one expires.

Endpoint

Australia: POST /authCode/oauth2/token/<countryCode>/<businessCode>

Parameters

PATH

countryCode

businessCode

FormData

grant_type

code

redirect_uri

Customers review and update their contact information

Customers are given the option to review their address, email address and phone number details. They can choose any one option at a time and update the corresponding details.
Zoom In

Customers review their address details

Customers can revisit the address details that they shared earlier and update their details by clicking on 'Edit'. Address details include fields like address type, address line 1, city, state, postcode, country, etc.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve customer home address

This API is used to retrieve customer home address details.

Endpoint 

Australia: GET /v1/customers/profiles/addresses

Parameters

PATH

NA

Customers update their address details

After making the desired changes to their address details, customers can click 'Save' to save these changes.
Zoom In

Is the mailing address the same as the residence address?

Customers will be prompted to specify if their mailing address is the same as their residence address. If they select 'Yes', they simply click on 'Save' to save the address details. 
Zoom In

Customers share their mailing address details

By clicking 'No', customers indicate that their mailing address is not the same as their residence address. After clicking 'Save', they will be taken to a page where they can provide their mailing address details.
Zoom In

Customers update their mailing address

Customers share their mailing address details such as address type, address line 1, etc., and then click on 'Save' to save their changes.
Zoom In

Customers continue to update their mailing address details

Customers can continue to provide their new mailing address details which include city, state, postcode, country, etc., and then click on 'Save' to save their changes.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Customer Address Update

This API is used to update customer's address details.

Endpoint

Australia: POST /v1/customers/profiles/addresses

Parameters

PATH

NA

Validate the one-time password before updating address details

Customers need to validate the one-time password sent by Citi on their registered mobile number to confirm their address update. Refer to API Callout 1 for information about retrieving an access token and API Callout 2 for information on the address update confirmation.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Authorization code grant: Retrieve access token

Get an access token issued by calling our token endpoint and passing the authorization code from the previous call. The issued access token will expire, and will be valid only for the scope for which the consent has been provided by the customer. You can call the APIs by passing this token in the authorization header.

You also get a refresh token that can be used to get a new access token in case the original one expires.

Endpoint

Australia: POST /authCode/oauth2/token/<countryCode>/<businessCode>

Parameters

PATH

countryCode

businessCode

FormData

grant_type

code

redirect_uri

View Api Callout 2 >
×

Use Case Callout

Customer Address Update Confirmation

This API is required to confirm the customer’s address updates . This is triggered after a seccessful multi-factor authentication.

Endpoint

Australia: POST /v1/customers/profiles/addresses/confirmation

Parameters

PATH

NA

Body

controlFlowId

Address update confirmation

After the one-time password validation, customers receive a confirmation message from Citibank to let them know that their address details have been successfully updated.
Zoom In

Customers review their email address details

Customers review their primary and alternate email addresses and click on 'Edit' to make any desired changes.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

To retrieve customer email address details

This API is used to retrieve customer email address details.

Endpoint

Australia: GET /v1/customers/profiles/emails

Parameters

PATH

NA

Customers update their email address

After making the desired changes to their email address details, customers can click on 'Save' to save these changes.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Customer Email Update

This API is used to update a customer's email address.

Endpoint

Australia: PUT /v1/customers/profiles/emails

Parameters

PATH

NA

Validate the one-time password before updating email address details

Customers receive a one-time password from Citi on their registered mobile number and then validate it to confirm their email address update. Refer to API Callout 1 for information about retrieving an access token and API Callout 2 for information about the email address update confirmation.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Authorization code grant: Retrieve access token

Get an access token issued by calling our token endpoint and passing the authorization code from the previous call. The issued access token will expire, and will be valid only for the scope for which the consent has been provided by the customer. You can call the APIs by passing this token in Authorization header.

You also get a refresh token that can be used to get a new access token in case the original one expires.

Endpoint

Australia: POST /authCode/oauth2/token/<countryCode>/<businessCode>

Parameters

PATH

countryCode

businessCode

FormData

grant_type

code

redirect_uri

View Api Callout 2 >
×

Use Case Callout

Customer Email Update Confirmation

This API is required to confirm the customer’s email address updates. This is triggered after a successful multi-factor authentication.

Endpoint

Australia: POST /v1/customers/profiles/emails/confirmation

Parameters

PATH

NA

Body

controlFlowId

Email address update confirmation

After the one-time password validation, customers receive a confirmation message from Citibank to let them know that their email address details have been successfully updated.
Zoom In

Customers review their phone number details

Customers can review their phone number details including home phone number, business phone number and mobile number. They can then click on 'Edit' to make any desired changes.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve customer phone numbers

This API is used to retrieve customer phone numbers.

Endpoint

Australia: GET /v1/customers/profiles/phoneNumbers

Parameters

PATH

NA

 

Customers update their phone number

After making the desired changes to their phone number details, customers can click on 'Save' to save their changes.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

CustomerPhoneNumberUpdate

This API is used to update a customer's phone number.

Endpoint

Australia: PUT /v1/customers/profiles/phoneNumbers

Parameters

PATH

NA

Validate the one-time password before updating phone number

Customers receive a one-time password from Citi on their registered mobile number and then validate it to confirm their phone number update. Refer to API Callout 1 for information about retrieving an access token and API Callout 2 for information about the phone number update confirmation.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Authorization code grant: Retrieve access token

Get an access token issued by calling our token endpoint and passing the authorization code from the previous call. The issued access token will expire, and will be valid only for the scope for which the consent has been provided by the customer. You can call the APIs by passing this token in the authorization header.

You also get a refresh token that can be used to get a new access token in case the original one expires.

Endpoint

Australia: POST /authCode/oauth2/token/<countryCode>/<businessCode>

Parameters

PATH

countryCode

businessCode

FormData

grant_type

code

redirect_uri

View Api Callout 2 >
×

Use Case Callout

Customer Phone Number Update Confirmation

This API is required to confirm the customer’s phone number updates. This is triggered after multi factor authentication is successful.

Endpoint

Australia: POST /v1/customers/profiles/phoneNumbers/confirmation

Parameters

PATH

NA

Body

controlFlowId

Phone number update confirmation

After the one-time password validation, customers receive a confirmation message from Citibank to let them know that their phone number details have been successfully updated.
Zoom In