Skip to content

Integrations

An integration connects one of your existing systems to Checktiv so that identity verification starts on its own. When the connected system creates or updates a record, such as a reservation, Checktiv picks it up, starts a verification when that record’s verification opens (by default, right away), and can invite the person to complete it, all without anyone opening the console. You manage integrations from Dashboard → Integrations.

Use an integration when the event that should trigger a verification already happens in another tool you run. Instead of exporting a list and starting verifications by hand, or building against the API yourself, you connect the system once and every new record it creates starts a verification automatically.

This suits teams that:

  • Take new bookings, reservations, or customer records in a system Checktiv can connect to, and want each one verified.
  • Prefer a no-code setup over writing against the REST API.
  • Want a consistent set of checks applied to everyone, without depending on staff to remember to start each verification.

If you only need to verify a handful of people, or want to script the flow yourself, start a verification directly or use the API instead.

Once you connect a system, each new or changed record flows through automatically. Depending on the integration, Checktiv either receives it the moment it happens, or checks the connected system for new and changed records on a regular schedule; each integration’s own guide states which:

  1. The connected system creates or updates a record (for example, a new or changed reservation), and Checktiv picks it up, either right away or on its next scheduled check.

  2. Checktiv reads the record and acts on its status first: a canceled record starts no verification (it withdraws one still waiting, as each integration guide describes), and a record in a state the integration cannot read is skipped. Only then does it apply your routing rules: unless the first rule that matches is a Skip rule, it gives the record its own verification link. A verification starts when the record’s verification opens. It is bound to the workflow the first matching rule selects, or to the connection’s default workflow when no rule selects one.

  3. A record keeps one link for its whole verification window. If its verification lapses before the person starts any paid check, the same link starts a new one. Once a verification for a record has started paid checks, a second one starts only when you reopen the record and confirm the charge.

  4. Depending on your invite setting, Checktiv either sends the verification invite itself or leaves that to the source system.

Each verification an integration starts appears in your Applicants list alongside verifications you start any other way, and runs the same checks and review flow.

Every connection binds to one default workflow, which is required. It is the workflow template that every verification from this connection runs unless a routing rule selects another workflow, so it decides which checks each person goes through by default.

You choose the default workflow when you connect a system, and you can change it later by editing the connection. You cannot connect a system until you have at least one workflow template to bind, so create a workflow template first if you have none.

Without any routing rules, every record from a connected system starts a verification. Routing rules let you narrow that down so only the records you want are verified, or choose which workflow runs for them. Depending on the integration, a new connection starts with one or more routing rules already in place, seeded for you, such as a rule that skips records in an early or pre-commitment state. You can edit or remove them like any other rules.

The seeded rules are added above any rules you create while connecting, so they are checked first. A Select workflow rule you add on a value a seeded rule already matches (for example a Record status of Inquiry) does not take effect until you move it above the seeded rule or remove that rule, which you can do by editing the connection once it is connected. The connect form lists the seeded rules for the integration you are connecting.

A routing rule has one or more conditions on the fields of a record. When all of its conditions match the record, the rule takes one of two actions. Skip verification starts no verification for the record. Select workflow starts the verification on the workflow you pick for that rule instead of the default workflow. These are the platform’s names for the fields, in the alphabetical order the rule builder lists them in:

  • Channel: a second origin field, on a connected system that records two of them. It does not contain or replace Source below: a record can have one, the other, both, or neither.
  • Confirmation code: the code the connected system gives the person.
  • Currency: the currency of that total.
  • Email: the email address on the record.
  • End date: the departure or end date on the record.
  • First name: the first name of the person on the record.
  • Full name: the full name of the person on the record.
  • Last name: the last name of the person on the record.
  • Lead time (days): the number of whole days from the day the booking was made to the check-in day, both counted on the property’s calendar. 0 is a same-day booking, and a booking made after check-in has a negative lead time. A record that does not carry what this needs, such as one that does not say when the booking was made, has no lead time, so a rule on it does not match that record.
  • Location address: the street address of the property, listing, or unit.
  • Location group ID: the identifier of the group, node, or portfolio the location belongs to.
  • Location ID: the identifier of the property, listing, or unit.
  • Phone: the phone number on the record.
  • Rate code: the code of the rate or rate plan the record was booked on.
  • Rate name: the name of that same rate or rate plan. Connected systems show the code in some places and the name in others, so both are available and you enter whichever one you can read.
  • Record status: the state of the record, such as Confirmed or Inquiry.
  • Record type: the connected system’s own classification of the record, such as a direct booking or an owner stay. Separate from its status, and a record has both.
  • Reference ID: the identifier of the record in the connected system.
  • Source: the connected system’s main origin field for the record, whatever it calls that field. On a system with one origin field this is the channel the booking came through. On one with two it is the more specific of them, and the other is Channel above.
  • Start date: the arrival or start date on the record.
  • Time zone: the time zone of the property, listing, or unit.
  • Total amount: the total value of the record.

Where a connected system has its own name for one of these fields, the rule builder shows that name instead, so a drawer can name a field differently from the list above. Each integration guide names the fields exactly as that connection’s rule builder shows them, and is the one to follow when the two differ.

A connection offers only the fields its connected system sends, so the set differs by connection. The rule builder lists the fields that connection supports, and that list is the authoritative one. Each integration guide states the set for that integration and the value behind each field; the Track guide carries the full table.

Each condition holds a list of values, except a number comparison on Lead time (days), which holds one number. With is one of, a condition matches a record when its field has one of those values. The sections Leave out values with “is not one of” and Compare lead time with a number describe the other operators. A common use is to exclude records that arrive from a channel you do not want to verify. Which field carries that channel differs by connected system, so read the integration guide. Do not assume that the field is Source. How is one of compares a value depends on the field:

  • Identifiers, dates, and the record status must match exactly, including capitalization.
  • Names, email, address, currency, time zone, rate code, rate name, channel, source, record type, and confirmation code match while ignoring capitalization.
  • A phone number matches on its digits, so punctuation and spacing make no difference.
  • A total amount and lead time match on value. A total amount of 1557 matches 1557.00. A lead time matches as a whole number of days, so +03 matches 3.

There are no wildcards and no partial matches. A field the record leaves empty never matches is one of or is not one of. If a rule has no effect, make sure that its fields are not empty on the record.

Rules are evaluated from top to bottom, and the first rule that matches decides the outcome, whichever action it takes. A record that no rule matches is verified on the connection’s default workflow. You can add several rules per connection, to cover multiple exclusions or to send different records to different workflows.

Because the first match wins, order matters. For example, you want the listings in one market to use their own workflow, and you do not want to verify owner stays there. Put the rule that skips owner stays above the rule that selects that market’s workflow. An owner stay then matches the Skip rule first, so Checktiv does not verify it, in this market or in any other. The Skip rule has no condition on the market, so it applies to every owner stay. This is usually what you want. Every other record in the market matches the Select workflow rule. In the opposite order, owner stays in that market would be verified on the market’s workflow. Use the move up and move down buttons beside each rule to change the order.

A workflow that an integration uses, either as its default or in a Select workflow rule, cannot be deleted or deactivated. The attempt is refused and names the integrations that use it. Open each of those integrations (or, if you cannot open Integrations, ask an owner or admin to), pick a different workflow, save, and then delete or deactivate the workflow.

A rule can have more than one condition. A rule matches a record only when all of its conditions match the record. A rule can have up to four conditions.

Each condition has a field, an operator, and one or more values. The rule builder shows the field of the first condition under When, and the field of each other condition under And. It shows the operator under Match and the values under Values. A new condition starts with the operator is one of.

To add a condition to a rule, select Add condition in that rule. To remove a condition, select Remove condition in that condition. When a rule has the maximum number of conditions, you cannot select Add condition.

Example: Skip the records of one listing that come from one channel.

  1. Select Add rule. Set the first condition to Location ID is one of L-100.
  2. Select Add condition. Set the second condition to Source is one of Example Channel.
  3. Under Then, select Skip verification.

The rule skips a record only when its Location ID is L-100 and its Source is Example Channel, in any capitalization. A record at L-100 from another channel does not match this rule, so Checktiv evaluates the next rule. If no rule matches a record, Checktiv verifies the record on the default workflow.

To match one of several values in one field, put all of the values in one condition. Do not make two conditions on the same field for this. A record matches the rule only when both conditions match.

When each condition has a value, the rule builder shows a sentence under the rule that tells what the rule does. Read that sentence before you save.

Each condition uses one of seven operators. Three of them compare a field with a list of values. The other four compare a number, and Compare lead time with a number describes them.

Operator Matches a field that is not empty when Matches an empty field
is one of The value is in the list. No
is not one of The value is not in the list. No
is not one of, or empty The value is not in the list. Yes

A field is empty when it has no text, or when it holds only spaces or invisible characters. On Phone, a value with no digits, such as n/a, is also empty. Phone reads only the digits 0 to 9, so a number in other digits, such as Arabic-Indic digits, is also empty. The rule builder does not accept an empty value, such as n/a on Phone, in a condition that uses is not one of or is not one of, or empty, because such a condition never matches.

is not one of and is not one of, or empty compare values in the same way as is one of, with three differences. They ignore invisible characters. They treat different forms of the same character as equal, such as a full-width A and A. On the fields that must match exactly, they also ignore capitalization and spaces at the start and end.

Because of this, is one of and is not one of are not opposites, and a record can match neither of them. On Location ID, l-100 does not match is one of L-100, because Location ID must match exactly. It does not match is not one of L-100 either, because that operator ignores capitalization. A record whose field is empty also matches neither of them.

On Phone and Total amount, the operators have no other difference. So a phone number with and without its country code counts as two different values for every operator. An amount with a decimal comma, such as 1.234,56, does not equal 1234.56. Write each value in the form that your connected system sends.

Example: Select a workflow for the records of one listing, except the records from one channel.

  1. Select Add rule. Set the first condition to Location ID is one of L-100.
  2. Select Add condition. Set the second condition to Source is not one of Example Channel.
  3. Under Then, select Select workflow, and choose the workflow.

For a record at L-100, the Source of the record decides the result:

Source of the record Does the rule match?
Other Channel Yes
Example Channel No
example channel No
Empty No

The rule does not match a record at L-100 whose Source is empty, so Checktiv evaluates the next rule. To include those records, set the second condition to is not one of, or empty. Then the record in the Empty row also matches. With an is not one of condition, the sentence under the rule also says that a record whose field is empty does not match.

When its other conditions match, a Skip verification rule with is not one of, or empty also skips a record whose field is empty. Make sure that you want to skip those records.

The rule builder offers only the fields that the connection sends. But a saved rule can have a condition on a field that the connection does not send. With is one of or is not one of, that condition never matches, and the rule builder shows a warning. With is not one of, or empty, that condition would match every record, so Checktiv does not use it, and the rule does not match any record. The rule builder shows an error on that condition. You cannot save the connection until you change the field or the operator, or remove the condition or its rule.

Some rules have only conditions that use is not one of or is not one of, or empty. Such a rule also matches records with new values that you did not plan for. Under a Skip verification rule like this, the rule builder shows a warning when each condition has a value. The warning does not stop you from saving the rule. To make the rule narrower, add a condition that uses is one of.

Four more operators compare a number of days, and are available only on Lead time (days). Each takes one whole number, from -3650 to 3650:

Number operator Matches a lead time that is
is less than Less than the number you enter.
is at most The number you enter, or less.
is greater than Greater than the number you enter.
is at least The number you enter, or more.

On Lead time (days), the rule builder removes a plus sign and leading zeros from every number that you enter, under every operator, so it saves +03 as 3.

A record with no lead time matches none of the four. A booking made after check-in has a negative lead time, so is less than 0 matches it.

Each connection decides when verification opens and when it is due. By default, verification opens as soon as a record reaches Checktiv, and it is due at the deadline of the first verification that starts for it, which its workflow template sets. You can instead open it a number of days before the record’s start date, such as a check-in. You can also make it due a number of days after the record arrives, or a number of hours before its start date. Set it in the Verification timing section when you connect or edit a connection. See Verification timing for how each setting works and what the person sees.

When a verification starts from an integration, someone needs to receive the link to complete it. The Send the verification invite setting controls who sends it.

  • On: Checktiv emails the verification link to the person automatically when verification opens: right away with the default timing, or on the day your timing opens it. When your organization has automatic reminders turned on, the person also receives one extra reminder 24 hours before their verification’s deadline, unless a message already reached them in that final day.
  • Off: a connection that you connect yourself starts with this setting. Checktiv does not send the invite. The source system is responsible for inviting the person, using the verification link that Checktiv writes back to that system. When verification opens later than the record arrives, the verification starts when the person opens that link. Leave it off only when the source system is set up to deliver that link, otherwise the person will not receive it. If you send an invite from the applicant’s page in Checktiv (Send invite), your organization’s automatic reminders apply to that person. A person invited only by the connected system, or by nobody, receives no reminder.

When Checktiv sends an invite, the email uses the invite copy of the verification’s workflow template. If that workflow template has no invite copy, the email uses the platform default copy. To change the copy, see Customize the invite message.

Checktiv limits the invite emails that go to one email address. If a connected system starts a verification after that limit is reached, Checktiv creates the verification and sends no invite. Send the invite from the applicant’s page in your Applicants list. See Per-recipient invite limit.

A new connection, including one you connect again after a disconnect, starts with Send the verification invite off. Turn it on when you connect a system, or later with Edit on the connection, to have Checktiv email each applicant their link. A Mews property that is connected for you, or that you approve, copies the setting of your chain’s most recent connection instead; see Later properties of a chain. A connection that already exists keeps its setting, which the connection’s Edit drawer shows.

Turning Send the verification invite on invites the people whose verification opens after the change. To invite a person whose verification already started, open it in your Applicants list and select Send invite (see Resend or revoke). If their verification has not started yet, share the verification link that Checktiv writes back to the source system.

Connected integrations are listed under Dashboard → Integrations. From there you can:

  • Connect a system from the catalog below by entering its credentials, choosing a default workflow, setting routing rules, choosing a verification timing, and confirming the invite setting.
  • Edit a connection to change its default workflow, routing rules, verification timing, or invite setting. You can leave the credentials blank when editing to keep the ones already stored.
  • Reconnect a connection whose credentials have stopped working. Checktiv flags a connection as needing reconnection when it can no longer reach the system; reconnecting prompts you for fresh credentials.
  • Pause a connection to stop it starting new verifications while keeping it configured, then Resume it later to start again. A paused connection ignores new records until you resume it, and a person who opens their verification link while it is paused is asked to try again later.
  • Disconnect a connection to remove it. This stops new verifications from the system and is confirmed before it takes effect. Verifications that already started continue, but the verification links written to your records stop working. If you connect the system again, a record gets a new link the next time it changes there, and the new connection starts with Send the verification invite off.

Hostaway, Guesty, Track, and Streamline are available to connect. Mews is offered region by region: its tile in the catalog shows whether your region offers it. Additional integrations across property management, payments, and business apps appear in the catalog as they become available. If an integration is not offered in your region, its tile in the catalog says so, and you can still start verifications from the console or through the API.