Identity API

The Customer Identity API allows for the creation, validation, updating, and management of customers.

📘
Note that this API is not always required, and will only be used when doing an integration with an ecommerce which wapping doesn't provide default integration, or in other specific cases.
Consult with Wapping onboarding team to clarify if the integration will be needed for your specific scenario.

The API handles Identities. This can be thought of "accounts" of a customer, once validated they can create a new customer, or link to an existing one.

🚧
Be aware that this API won't reply with the entity created, just with a http code, as not all the identities will create a customer.
To receive back the information the connection with webhook API must be stablished, as all the new customers, or linked identities, will be informed through there.

The usage of the API is done through the /identity method, to create or update an identity.

After, the validation can be sent to the customer using /identity/validation/send, specifying the identity information registered previously (thirdPartyId, thirdPartySystemId plus thirdPartySystemCode if it's custom).

Lastly, to validate the identity, the /identity/validation/confirm must be used

📘
It is also common to just create the identity and then delegate the validation in Wapping through the Wallet embedded through iframe.
Again, consult with the Wapping Onboarding team to clarify each scenario.

There are three key characteristics related to a customer's identifier apart from the common properties:

SystemId: The external system ID for the customer identifier.
CustomSystemCode: The external system code in case it is a type 3 systemId. Note that this code has to be created in the tenant before using.
Identifier: The customer identifier in the external system.

Through this mechanism, an identity can be associated with the customer, linking them to an external system, such as an existing business system, an e-commerce platform, etc.

This allows different identification methods to be associated with a customer. Once validated, these contribute to building a 360-degree customer identity.

In this case, the current customer identity in the business master system would be defined as follows:

{
  "systemId": 3,
  "customSystemCode": "id_custom_system",
  "identifier": "4938926493",
  "mobilePhone": "string",  
  "email": "string",
  "contact": {
    "name": "string",
    "phoneNumber": "string"
  }
}

This indicates that it is a custom system (systemId = 3), specifies the custom system identifier (a predefined text string), and includes the actual identifier.

If there are customers with validated phone numbers already in the system, they can be registered as validated using the flag "mobilePhoneValidated": true.

🚧
Use this with caution and only when the customers phones are unequivocally validated, as the phone validation is the cornerstone of the Wapping unified Identity.