API Reference (1.0)

Complero uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Complero’s servers (these are rare).

Each validation error is mapped to a specific code.

• Tags related to standard validation rules (such as email, uuid, min, etc.) return the generic code v1c001.

• The required tag is treated as a special case and returns v1c002.

• Tags specific to Complero's domain, such as mobilenumber, faxnumber, or zipcode, return v1c004.

• Any other unknown or unrecognized tags fall back to the generic code v1c003.

Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id.

To expedite the resolution process, provide the request identifier when you contact us about a specific request.

Get endpoints that return an array of Models support cursor based pagination.

By default, it returns only 1000 events per page and next page can be requested by passing cursor query parameter with value from response header Next-Cursor.

For convenience, response also has header Next-Link which contains full link what can be used for requesting next page.

Headers Next-Cursor and Next-Link will be present in the headers as long as next page exists.

Consumers receiving Complero Update Requests.

Individuals employed by your entity. Adding employees is optional, but recommended for Companies with branch offices or when different groups of contacts are managed by separate agencies or Employees. If no employee is specified, all uploaded Contacts will be assigned to the default Employee.