Impact migration of the route GET /v0/customers/{customer_id}/profile

  • Outdated
  • October 11, 2023
  • 1 related route

Upgrade from GET/v0/customers/{customer_id}/profile to GET/v2/customers/{customer_id}/profile

ℹ️ Input parameters : unchanged ℹ️ In the Response -> the identity_number field is deleted then replaced by a new object called identity as described below ℹ️ Response value can be null

Impacts

Call GET/v2/customers/{customer_id}/profile instead of GET/v0/customers/{customer_id}/profile

Response

Output example value

{
  "gm_number": "20880342",
  "email": "jeanbarasdumonde@yopmail.com",
  "gender": "M",
  "civility": "MR",
  "unicode_civility": "",
  "first_name": "JEAN",
  "unicode_first_name": "",
  "last_name": "BARAS",
  "unicode_last_name": "",
  "health_pass_id": "",
  "language_code": "FR",
  "birth_country_code": "",
  "customer_type": "CLIENT",
  "customer_status": "PROSPECT",
  "birthdate": "19850211",
  "birthday": "19850211",
  "personal_data_usage_allowed": false,
  "address": {
    "number": "",
    "street": "",
    "town": "",
    "city": "",
    "country": "FRANCE",
    "add_on": "",
    "zip_code": "",
    "state_or_district": "",
    "country_code": "FR",
    "additional_information_1": "",
    "additional_information_2": ""
  },
  "loyalty_program": {
    "points": 0,
    "status": "NONE"
  },
  "optins": [
    {
      "channel": "EMAIL",
      "optin": false,
      "optin_partners": false
    }
  ],
  "phones": [],
  "blacklisted": false,
  "_links": [
    {
      "href": "https://api-test/v0/customers/144900489/profile",
      "method": "GET",
      "rel": "self"
    },
    {
      "href": "https://api-test/v0/schemas/profile/fr-FR",
      "method": "GET",
      "rel": "schema"
    },
    {
      "href": "https://api-test/v1/schemas/profile/fr-FR",
      "method": "GET",
      "rel": "schema_v1"
    }
  ],
-  "identity_number": "E001241",
+  "identity": {
+    "number": "E001241",
+    "type": "TAX_NUMBER"
  }
}

Model

FieldDescriptionTypeExample
identity.number National identifier code attached to the identity documentstring"E001241"
identity.typeType of national identifier code (CPF, CUIL, TAX_NUMBER, SECURITY_NUMBER, ID_NUMBER, NATIONAL_REGISTERstring"TAX_NUMBER"