NAV

addCustomer

POST /customer/add

This endpoint allows the developer to create a customer within SimplePin’s database. Please note, that before creating a new customer, you need to call endpoint getCustomer to validate if such a customer even exists in SimplePin’s database. When creating a customer, please pay specific attention to the country and province of the customer. For that reason, you have to use getCountries and getProvinces endpoints.

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.

ccProfileModel (required)

This is the data required in order to create customer profile.

Response Messages
Code
Description
200
OK
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
             {
    "address": "string",
    "billing_address_id": 0,
    "billing_address_models": [
        {
            "address": "string",
            "city": "string",
            "country": 0,
            "country_formated": "string",
            "id": 0,
            "province": 0,
            "province_formated": "string",
            "selected": true,
            "zip": "string"
        }
    ],
    "city": "string",
    "contract_email": "string",
    "country": 0,
    "country_formated": "string",
    "creation_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "customer_name": "string",
    "customer_profile": 0,
    "customer_since": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "id": 0,
    "phone_number": "string",
    "policy": "string",
    "province": 0,
    "province_formated": "string",
    "status": "REQUIRES_ACTIVATION",
    "version": 0,
    "zip": "string"
}
             
          
{ } CCProfileModel
address optional string
billing_address_id optional integer
billing_address_models optional array|BillingAddressModel
city optional string
contract_email optional string
country optional integer
country_formated optional string
creation_date optional string
customer_name optional string
customer_profile optional integer
customer_since optional string
id optional integer
phone_number optional string
policy optional string
province optional integer
province_formated optional string
status optional string
version optional integer
zip optional string
{ } BillingAddressModel
address optional string
city optional string
country optional integer
country_formated optional string
id optional integer
province optional integer
province_formated optional string
selected optional boolean
zip optional string
             {
    "address": "string",
    "billing_address_id": 0,
    "billing_address_models": [
        {
            "address": "string",
            "city": "string",
            "country": 0,
            "country_formated": "string",
            "id": 0,
            "province": 0,
            "province_formated": "string",
            "selected": true,
            "zip": "string"
        }
    ],
    "city": "string",
    "contract_email": "string",
    "country": 0,
    "country_formated": "string",
    "creation_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "customer_name": "string",
    "customer_profile": 0,
    "customer_since": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "id": 0,
    "phone_number": "string",
    "policy": "string",
    "province": 0,
    "province_formated": "string",
    "status": "REQUIRES_ACTIVATION",
    "version": 0,
    "zip": "string"
}
             
          
{ } CCProfileModel
address optional string
billing_address_id optional integer
billing_address_models optional array|BillingAddressModel
city optional string
contract_email optional string
country optional integer
country_formated optional string
creation_date optional string
customer_name optional string
customer_profile optional integer
customer_since optional string
id optional integer
phone_number optional string
policy optional string
province optional integer
province_formated optional string
status optional string
version optional integer
zip optional string
{ } BillingAddressModel
address optional string
city optional string
country optional integer
country_formated optional string
id optional integer
province optional integer
province_formated optional string
selected optional boolean
zip optional string
             <cc_profile_model>
  <address>string</address>
  <billing_address_id>0</billing_address_id>
  <billing_address_model>
    <address>string</address>
    <city>string</city>
    <country>0</country>
    <country_formated>string</country_formated>
    <id>0</id>
    <province>0</province>
    <province_formated>string</province_formated>
    <selected>1</selected>
    <zip>string</zip>
  </billing_address_model>
  <billing_address_model>
    <address>string</address>
    <city>string</city>
    <country>0</country>
    <country_formated>string</country_formated>
    <id>0</id>
    <province>0</province>
    <province_formated>string</province_formated>
    <selected>1</selected>
    <zip>string</zip>
  </billing_address_model>
  <city>string</city>
  <contract_email>string</contract_email>
  <country>0</country>
  <country_formated>string</country_formated>
  <creation_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</creation_date>
  <customer_name>string</customer_name>
  <customer_profile>0</customer_profile>
  <customer_since>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</customer_since>
  <id>0</id>
  <phone_number>string</phone_number>
  <policy>string</policy>
  <province>0</province>
  <province_formated>string</province_formated>
  <status>REQUIRES_ACTIVATION</status>
  <version>0</version>
  <zip>string</zip>
</cc_profile_model>

             
          
{ } CCProfileModel
address optional string
billing_address_id optional integer
billing_address_models optional array|BillingAddressModel
city optional string
contract_email optional string
country optional integer
country_formated optional string
creation_date optional string
customer_name optional string
customer_profile optional integer
customer_since optional string
id optional integer
phone_number optional string
policy optional string
province optional integer
province_formated optional string
status optional string
version optional integer
zip optional string
{ } BillingAddressModel
address optional string
city optional string
country optional integer
country_formated optional string
id optional integer
province optional integer
province_formated optional string
selected optional boolean
zip optional string
             <cc_profile_model>
  <address>string</address>
  <billing_address_id>0</billing_address_id>
  <billing_address_model>
    <address>string</address>
    <city>string</city>
    <country>0</country>
    <country_formated>string</country_formated>
    <id>0</id>
    <province>0</province>
    <province_formated>string</province_formated>
    <selected>1</selected>
    <zip>string</zip>
  </billing_address_model>
  <billing_address_model>
    <address>string</address>
    <city>string</city>
    <country>0</country>
    <country_formated>string</country_formated>
    <id>0</id>
    <province>0</province>
    <province_formated>string</province_formated>
    <selected>1</selected>
    <zip>string</zip>
  </billing_address_model>
  <city>string</city>
  <contract_email>string</contract_email>
  <country>0</country>
  <country_formated>string</country_formated>
  <creation_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</creation_date>
  <customer_name>string</customer_name>
  <customer_profile>0</customer_profile>
  <customer_since>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</customer_since>
  <id>0</id>
  <phone_number>string</phone_number>
  <policy>string</policy>
  <province>0</province>
  <province_formated>string</province_formated>
  <status>REQUIRES_ACTIVATION</status>
  <version>0</version>
  <zip>string</zip>
</cc_profile_model>

             
          
{ } CCProfileModel
address optional string
billing_address_id optional integer
billing_address_models optional array|BillingAddressModel
city optional string
contract_email optional string
country optional integer
country_formated optional string
creation_date optional string
customer_name optional string
customer_profile optional integer
customer_since optional string
id optional integer
phone_number optional string
policy optional string
province optional integer
province_formated optional string
status optional string
version optional integer
zip optional string
{ } BillingAddressModel
address optional string
city optional string
country optional integer
country_formated optional string
id optional integer
province optional integer
province_formated optional string
selected optional boolean
zip optional string