Connect Zapier

You connect Zapier with an API key from Settings. The key belongs to one workspace. It cannot read another workspace.

Create your API key

1. 1

   Sign in.

2. 2

   Open Settings.

3. 3

   Under API keys, enter a name you will recognise, such as Zapier.

4. 4

   Select Create API key. FreeAML shows the key once. Copy it into Zapier. We store only a hash.

5. 5

   In Zapier, add the FreeAML connection and paste the key. Reports from actions you run go to the email on the account that created the key.

Triggers

Zapier can start a Zap when something happens in your workspace. FreeAML sends the event to the hook Zapier gives you.

• Verification completed. The status is complete and the report is ready. You receive the verification id, reference, client email when we have one, person or entity, paid or unpaid, the completed time, a report link when there is one, and the workspace id.
• Verification failed, expired, or declined. FreeAML stores those as rejected, expired, and declined.
• Verification created. A new verification exists. invite_sent is true when the client email has gone out.

The payload does not include identity document images.

Actions

• Create verification. Enter the client email, an optional reference, an optional role, and who pays. Choose Your client pays or Your workspace pays. When your client pays, they choose person (KYC) or entity (KYB) on the link. An individual check is $20. A company, trust, or SMSF check is $40. You can add a service charge of $0, $25, $50, or $100 on that verification only. When your workspace pays, you choose person or entity before the invite is emailed, and there is no service charge. The report email is the account that created the API key.
• Find verification. Looks up one verification in this workspace by id or reference.

If a key stops working

• Revoke removes access immediately. Hooks that used that key stop as well.
• Paste a new key into Zapier. The old connection does not pick up the new key on its own.
• The FreeAML app in Zapier’s directory is published after Zapier reviews it. Until then, a Zapier account that has been invited to the app can still connect with your key.