This endpoint allows the developer to access SimplePin’s API in order to readily obtain customer information. It is used to identify if a customer exists in SimplePin’s database by the customer’s specific ID or email.
Parameters
Name
Description
locale
string
(optional)
This field is used to retrieve the provinces, countries and names of users. It returns a customer profile based on his/her specific language settings. So if we create a customer and set his/her settings to French, then SimplePin's parameters will also be in French.
email
string
(optional)
This contains the unique customer email.
customer_id
string
(optional)
This is a unique customer ID which was previously created by you when using the addCustomer endpoint.
Response Messages
Code
Description
200
OK
401
Unauthorized
403
Forbidden
404
Not Found
{
"billing_address_id": 0,
"billing_address_models": [
{
"id": 0,
"zip": "string",
"city": "string",
"country": 0,
"province": 0,
"address": "string",
"selected": true
}
],
"contract_email": "string",
"contracts": [
{
"id": 0,
"name": "string"
}
],
"customer_id": "string",
"customer_name": "string",
"customer_since": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"id": 0,
"main_address": {
"id": 0,
"zip": "string",
"city": "string",
"country": 0,
"province": 0,
"address": "string",
"selected": true
},
"mobile_number": "string",
"phone_number": "string",
"status": "REQUIRES_ACTIVATION",
"version": 0
}
{ } CCProfileV2Model
billing_address_id
optional
integer
contract_email
optional
string
customer_id
optional
string
customer_name
optional
string
customer_since
optional
string
id
optional
integer
mobile_number
optional
string
phone_number
optional
string
status
optional
string
version
optional
integer
{ } AddressApiV2Model
id
optional
integer
zip
optional
string
city
optional
string
country
optional
integer
province
optional
integer
address
optional
string
selected
optional
boolean
{ } CcContractV2Model
id
optional
integer
name
optional
string
<cc_profile_model>
<billing_address_id>0</billing_address_id>
<billing_address_models>
<billing_address_model>
<id>0</id>
<zip>string</zip>
<city>string</city>
<country>0</country>
<province>0</province>
<address>string</address>
<selected>1</selected>
</billing_address_model>
<billing_address_model>
<id>0</id>
<zip>string</zip>
<city>string</city>
<country>0</country>
<province>0</province>
<address>string</address>
<selected>1</selected>
</billing_address_model>
</billing_address_models>
<contract_email>string</contract_email>
<contracts>
<contract>
<id>0</id>
<name>string</name>
</contract>
<contract>
<id>0</id>
<name>string</name>
</contract>
</contracts>
<customer_id>string</customer_id>
<customer_name>string</customer_name>
<customer_since>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</customer_since>
<id>0</id>
<main_address/>
<mobile_number>string</mobile_number>
<phone_number>string</phone_number>
<status>REQUIRES_ACTIVATION</status>
<version>0</version>
</cc_profile_model>
{ } CCProfileV2Model
billing_address_id
optional
integer
contract_email
optional
string
customer_id
optional
string
customer_name
optional
string
customer_since
optional
string
id
optional
integer
mobile_number
optional
string
phone_number
optional
string
status
optional
string
version
optional
integer
{ } AddressApiV2Model
id
optional
integer
zip
optional
string
city
optional
string
country
optional
integer
province
optional
integer
address
optional
string
selected
optional
boolean
{ } CcContractV2Model
id
optional
integer
name
optional
string