/customer[POST]
This operation allows to create customer details.
URL
https://nonprod.cwp.esb.cloud.lla.com/preprod/sfdc-ux-cwp/sfdc-ux/v1/{businessId}/customer
URI Params
| name | type | description | required |
|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
| name | type | description | required |
|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | N |
Request Body Definitions
| name | type | description | Required |
|---|
| name | String | name of the entity | Y |
| contactMedium | Array of objects | Indicates the contact medium that could be used to contact the party | Y |
| contactMedium[].mediumType | Object | Type of the contact medium, such as: email address, telephone number, postal address | N |
| contactMedium[].preferred | String | If true, indicates that is the preferred contact medium | N |
| contactMedium[].characteristic | Object | characteristics of the contactType | Y |
| contactMedium[].characteristic.street1 | String | Describes the street | Y |
| contactMedium[].characteristic.street2 | String | Complementary street description | N |
| contactMedium[].characteristic.stateOrProvince | String | State or province | N |
| contactMedium[].characteristic.city | String | The city | N |
| contactMedium[].characteristic.country | String | The country | N |
| contactMedium[].characteristic.postCode | String | postal code | N |
| contactMedium[].characteristic.phoneNumber | String | phone number of the contact | N |
| contactMedium[].characteristic.contactType | String | The type of contact | N |
| contactMedium[].characteristic.emailAddress | String | email address of the entity | N |
| characteristic[] | Array of objects | Describes the characteristic of a customer. | Y |
| characteristic[]. name | String | Name of the characteristic | Y |
| characteristics[].value | String | value of the characteristics. | Y |
| characteristics[]. valueType | String | Data type of the value of the characteristic | N |
Characteristics Name
| characteristic name | type | description |
|---|
| dateOfBirth | String | date of birth of customer |
| title | String | title of customer |
| gender | String | gender of customer |
| type | String | which type eg: residential or business |
| companyCode | String | company code |
| idProof | String | national id proof document |
| sourceEPC | String | Identifying the BSS System |
Sample Request
{
"name":"Tech Grouhie",
"contactMedium":[
{
"mediumType":"Address",
"preferred":false,
"characteristic":{
"street1":"35",
"street2":"sullivan avenue",
"city":"KINGSTON",
"stateOrProvince":"ST.ANDREW",
"postCode":"00006",
"country":"Panama"
}
},
{
"mediumType":"Telephone",
"preferred":true,
"characteristic":{
"phoneNumer":"1234566789",
"contactType":"home"
}
},
{
"mediumType":"Email",
"preferred":false,
"characteristic":{
"emailAddress":"donald.slicon@silicon.com",
"contactType":"email"
}
}
],
"characteristic": [{
"name": "dateOfBirth",
"valueType": "yyyy-MM-dd",
"value": "2000-06-12"
}, {
"name": "title",
"valueType": "Salutation Mr. Mrs. etc",
"value": "Mr"
}, {
"name": "gender",
"valueType": "string",
"value": "M"
}, {
"name": "type",
"valueType": "customerType",
"value": "COM"
}, {
"name": "companyCode",
"valueType": "String",
"value": "PAN"
}, {
"name": "idProof",
"valueType": "TR",
"value": "TR1325"
}, {
"name": "sourceEPC",
"valueType": "Identifying the BSS System",
"value": "Liberate"
}]
}
Sample Response:
{
"id": "36701370",
"account": [
{
"id": "367013700000"
}
]
}