CheckVault API

Before you start

Have these details ready.

Platform: trade creation, name and subdomain
Administrator: who manages your dashboard
Configuration: payments and SMS
API and branding, if you need them

Your email address So we can contact you about your setup.

Required. Answers are saved on this device only. Don’t enter passwords or API secrets.

Platform information

Tell us how you’ll use CheckVault and what to call your environment.

How will trades be created? Select all that apply.

CheckVault hosted dashboardCreate and manage trades in the CheckVault-hosted dashboard Handover API brokerTransactions are created in your portal, then handed to CheckVault to manage Full API marketplace brokerAPI only: create and manage trades entirely through the API CheckVault hosted iOS appOptional add-onSpeak to your CheckVault representative for more information

Environment name For example, MyCompany Escrow

Environment subdomain Lowercase letters, numbers and hyphens only.

.checkvault.com.au

Production: yourcompany.checkvault.com.au
Staging: yourcompany-staging.checkvault.com.au

SMS sender name The “from” name shown on SMS messages sent to mobile numbers. Maximum 11 characters.

0 of 11 characters

Administrator information

This is the main person responsible for managing the broker dashboard, for example inviting other members and setting permissions.

First name

Last name

Email address

Platform configuration

Choose how funds, payments and approvals work in your environment.

Release control lock Once a transaction is secured, should the broker confirm before funds can be released?

Yes No

Payment methods Select all that apply.

Bank transfer BPAY Debit BPAY Credit

Enable two-way SMS When a buyer or seller requests or offers a release, refund or split, the other party gets an SMS with a 6-digit code. They can reply with the code to approve it.

Yes No

API integration

Only needed if you’ll integrate with the CheckVault API. If you’re using the hosted dashboard, choose “None” and continue.

Primary integration method This helps us understand how you plan to integrate. Contact our support team if you’re unsure which applies.

NoneI’m using the CheckVault hosted dashboard APIv2: HandoverCreate trades by API, then hand over to the CheckVault front end APIv3: Full APIPerform every action through the API

Platform branding

Your environment can carry your own logo and colours.

Do you need custom branding at launch? Setup costs may apply depending on the customisation. Branding can also be added later.

Yes No Later

Your onboarding report

Reference · Created

Send your report to CheckVault

Download your report
A PDF copy of your answers to attach to the email.
Email it to our team
Your email app opens with your answers filled in. Attach the PDF, then press Send.
Email to CheckVault

Sent to corporate@checkvault.com.au. If the button doesn’t open your email app, email the PDF to that address yourself.

Your answers

Need to change something? Select “Change” next to a section, and your report will update.

Setting up another environment?

Escrow through our API

Three ways to connect

Hosted dashboard

Handover API

Full API

What the API covers

People

Trades

Your platform

What it costs

Setup fee

Annual fee

From form to live in four steps

Fill in the form, about five minutes

Email us the report

Build and test on staging

Go live on your subdomain

Broker onboarding

Before you start

Platform: trade creation, name and subdomain

Administrator: who manages your dashboard

Configuration: payments and SMS

API and branding, if you need them