checkClientForExistence

The checkClientForExistenceApi function prepares a standardized payload to check if a client already exists in a system based on a specific property (like an email, phone number, or internal ID).

Documentation

Try it now

Request parameters:

Name	Description	Type	Values	Default

value	Property that is being searched.	string	-	-
propId	The identifier for the type of property you are checking against. For example, it might represent "Email Field ID" or "Phone Field Id" so the database knows which column to search.	string	"email", "phone", "personalId"	-

Call example:
JavaScriptReact HookFlutter

checkClientForExistence({
  value: '35498598211',
  propId: 'email'
})

Response examples:
SuccessError

{
  result: 0,
  result_text: null,
  details: {
    Exists: false,
    ClientId: 0
  }
}

Response parameters:

Name	Description	Type	Values

Exists	Flag that shows if client is already registered	boolean	true / false
ClientId	Client id	string	-