The Customers API allows you to retrieve basic Citi customer information like name, mailing address, email address and phone numbers.

Note: The Developer Hub Sandbox is a test environment that allows you to make API calls that are the same in form and function to our production environments.  It contains mock test data so that you can prototype your application as if it were the real thing.  When you’re finished testing, contact sales to request production access

,

Note: Skip this step if you already created an app and have a pair of Client ID and Client Secret.

  1. Sign in to developer.citi.com
  2. Select My Applications tab.
  3. Click Register a New App
     

a. Fill out the required details

b. Upload an icon for your app (optional)

c. Click Submit

d. You will receive a pair of Client ID and Client Secret. Store this information securely. Use the Show button/checkbox to see your Client ID and Client Secret.

Note: Client secret is shown only once, so make sure you save this information. If in any case you lose your credential set, you can use the Regenerate button to get a new set of Client ID & Client Secret.

,

An access token is required to call all functional APIs. To retrieve your access token, visit your market’s Authorize guide.

,

Retrieve Customer Basic Name: GET /v1/customers/profiles/basic

Returns the Citi customer's name, including surname, prefix and suffix

Parameters

Value

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_ID

e5245bed-daaf-4eac-867b-57a564604fda

 

 

Retrieve Customer Email: GET /v1/customers/profiles/emails

Returns the Citi customer's email address

Parameters

Value

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_ID

e5245bed-daaf-4eac-867b-57a564604fda

 

 

Retrieve Customer Address: GET /v1/customers/profiles/addresses           

            Returns the Citi customer's primary mailing address

Parameters

Value

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_ID

e5245bed-daaf-4eac-867b-57a564604fda

 

 

Retrieve Customer Phone Number: GET /v1/customers/profiles/phoneNumbers

            Returns the Citi customer's home, office and mobile phone numbers

Parameters

Value

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_ID

e5245bed-daaf-4eac-867b-57a564604fda

,

Retrieve Customer All Information: GET /v1/customers/profiles

            Returns the Citi customer's name, email address, mailing address and phone numbers

Parameters

Value

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_ID

e5245bed-daaf-4eac-867b-57a564604fda