/users

get
get

Returns information about all your related company accounts

/accounts/{account}

get

Lists all added customers for the given company account

post

Registers a new person (customer) to follow up.

You can send multiple pieces of information (aka. pois), but at least the types 'person' (allowed values: 'P' for natural person, and 'E' for legal person) and 'name.full' must be included.

Following pieces of information are mandatory: person, name.full, id.national, birth.date, etc

post

Uploads a CSV file with new customers to be registered.

You can upload one single file each time, in CSV format and including the following fields separated by a semi colon (';'):

  • Type: (P) Natural person / (E) Legal person,
  • Full name,
  • National Identity Number (DNI, NIF),
  • Country issuing the document: coded with the norm ISO 3166-1 alfa-3, i.e. ESP for Spain, or DEU for Germany,
  • Birth date, formatted as AAAA-MM-DD
get

Returns all pending alerts

/accounts/{account}/customers/{customer}

get

Returns all information (visible for the given company account) of a customer

post

Removes a customer

You normally remove a customer when he/she is no longer your customer.

post

Splits a customer's pieces of information based on the source of the information

This endpoint allows to separate a customer that were merged by mistake to a wrong person by the matching algorithm.

get

Returns all events (visible for the current account) related to a person

get

Returns all alerts related to a given customer

/accounts/{account}/alerts/{alert}

get

Returns all information about one alert

post

Accepts and finishes the alert

post

Ignores and finishes the alert

post

Rejects and finishes the alert.

You reject an alert when it was based on a wrong person matching. Thus, you should call the enppoint /customers/{uuid}/split right after.