Customer Data API

The Customer Data API allows you to request views of individual customer data from the MXO customer profile.

Endpoints

The available endpoints and methods are:

HTTP MethodEndpointDescription
GET/one/oauth2/rt/api/2.0/profiles/Requests information about an individual customer, stored in the MXO customer profile.The format of the response is controlled by the structure you define.

Example use case: View customer data in the agent interface at the call center

You want to view customer data stored in the AEP in your agent interface. Using a structure, you can control the type and format of information that is made available in that interface.

Parameters

FieldDescription
Site keyONE-NX8P2RSAAU-1813
Touchpoint and contextapi://my.touchpoint/customer/interaction
Customer keymy-customer-id
TIDReturned on first request
Structurec1st_bank_aep

Structure

This structure makes information about a customers ID, preferred contact method, location, and any activity that customer has undertaken on the companies touchpoints regarding investments products available in the agent interface. This data could be used to to provide the agent with information about the next best conversation to have with that customer.

Customer data structure

Request

FieldDescription
Request methodGET
Request URL/one/oauth2/rt/api/2.0/profiles/c1st_bank_aep?sk=ONE-NX8P2RSAAU-1813&ck=CustomerKey
Request headersAuthorization header: HTTP Basic. Generated using the credentials supplied for the request, encoded in Base64.

Example: Authorization: Basic MmU4ZmVjMGUtMzRmYi00ODUxLTgwMGUtOTk4OTMzMWU1NWQ yOmQ3ZjQ0ODRmLTk4MTctNDc3OC05MTYxLTZlYjA2ZDFmNmNmNw==

Content-Type: application/x-www-form-urlencoded

Response

Expected response code

200 SUCCESS

Expected response body

{
   "Interaction_name":"Apply",
   "Geolocation":"New York",
   "Activity_Count_Investment_Products":5,
   "CustomerID":"CustomerKey",
   "ContactID":null
}