Some functions of our API need a few extra words.

Use our portal as blueprint

When you log in to your Flixcheck user in our portal at https://app.flixcheck.com, open your browser’s dev tools and watch the network tab. We recommend the following settings:

network-tab.png

Now you can see what our portal sends to and receives from our API. The only difference you have to take into account when developing an integration with our API is authentication. While the portal uses a session cookie, you will need to use the X-Flixcheck-Headers to authenticate with an API key.

<aside> 🚧

We are currently transitioning from our old API to the new v7 API. This documentation only covers the new API, but our portal uses the old routes on some places. Please do not adapt these deprecated routes but stick to v7 routes, since the old ones will be removed in the future.

</aside>

Recipient Properties

Property Type Required Description
mobile string Yes (only for sms) The recipient's mobile phone number
email string Yes (only for email) The recipient's email address
gender string No (only if informally is set as true) The gender of the recipient (male or female)
firstname string No The recipient's first name
lastname string No (only required if informally is set as true) The recipient's last name
name string No (only required if informally is not set) The recipient's full name
informally boolean No Specifies whether the recipient should be addressed personally or neutrally

A note about gender/firstname/lastname and name

Checks can be personal or neutral. A personal check has a gender, a firstname and a lastname. If one of those are set, the check is ment to be a personal check. The specific requirements when firstname or lastname are required depending on the informal checks are stated in the table above.

In case you want to create neutral check (e.g. if you don’t know the recipient’s name yet or when the check will be sent to an organization), then just fill out the name property. In that case, do not provide gender, firstname and lastname.

Custom Values

To append your own meta data to entities in Flixcheck, you can use “Custom Values”. They can be appended to:

Once set, these custom values stay at their place so you can use them in our own automation to re-identify these entities.