GoEscrow API Documentation

Introduction

Base URL: https://partners.staging.goescrow.net

Welcome to the GoEscrow Partner API Documentation for E-Commerce Retailers and Marketplace operators.

Base URL: https://partners.goescrow.net

This documentation aims to provide all the information you need to work with our API.

You may find the partner application, additional support documentation and whitepaper for the GoEscrow Partner API here.

Idempotency

State-changing requests can be safely retried without performing the operation twice by sending an Idempotency-Key header. We strongly recommend using it on every money-movement request, so that a network timeout or a retry never results in a duplicate transaction.

How to use it

Generate a unique value for each distinct operation (a UUID v4 is ideal) and send it as the Idempotency-Key request header.
If you repeat a request with the same key and the same body, the API returns the original response instead of performing the operation again. Replayed responses carry an Idempotent-Replayed: true header.
Keys are scoped to your partner account and remembered for 24 hours. After that window the same value may be reused for a new operation.

Status codes you may receive

409 Conflict — a request with the same key is still being processed. Wait a moment and retry.
422 Unprocessable Entity — the key was already used with a different request body. Use a new key for a different operation.

Notes

Only successful (2xx) responses are remembered. If a request fails, the key is released so you can safely retry it with the same key.
Reuse the same key only when retrying the same operation; use a fresh key for every new operation.

Idempotency keys are honoured on: create transaction, settle transaction, request cancellation, PayTo payment, and create dispute.

Always send an Idempotency-Key on money-movement requests, and retry with the same key after a network error — this guarantees the operation runs at most once.

Authenticating requests

To authenticate requests, include a X-API-Key header with the value "{YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

To connect via API authentication is required.

Contact your GoEscrow account manager for a one time use URL token to create your X-API-Key. Send that specific X-API-Key in a custom header (replacing '123456789abcdef') as follows:

POST /v1/transactions HTTP/1.1
Host: partners.goescrow.net
X-API-Key: 123456789abcdef
Content-Type: application/json
Accept: application/json

System

GET api/v1/healthcheck

GET

https://partners.staging.goescrow.net

/api/v1/healthcheck

requires authentication

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Example request:

curl --request GET \
    --get "https://partners.staging.goescrow.net/api/v1/healthcheck" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Company Management

Manage Companies

Lookup a company by ABN

GET

https://partners.staging.goescrow.net

/api/v1/companies/lookup

requires authentication

Looks up an existing company by Australian Business Number. Access is limited to companies represented by a user belonging to the authenticated partner, unless using an internal API key.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

abn

string

required

The Australian Business Number. Formatting spaces are accepted.

Example:

40 650 703 736

Response Fields

data

object

The unique identifier of the company

required

reference

The unique reference code for the company (GoEscrow ID)

required

name

The company name

required

abn

The Australian Business Number

required

acn

The Australian Company Number

required

kyb_verified

Whether the company has completed KYB verification

required

aml_verified

Whether the company has completed AML verification

required

aml_verified_at

Timestamp when the company completed AML verification

required

bank_verified

Whether the company has a verified bank account

required

abr_status

The status from the latest Australian Business Register lookup

required

representatives

The company representatives

required

Example request:

curl --request GET \
    --get "https://partners.staging.goescrow.net/api/v1/companies/lookup?abn=40+650+703+736" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "reference": "ABC123",
        "name": "Acme Corp Pty Ltd",
        "abn": "40650703736",
        "acn": "004085616",
        "kyb_verified": true,
        "aml_verified": true,
        "aml_verified_at": "2026-06-25T00:00:00.000000Z",
        "bank_verified": true,
        "abr_status": "Active",
        "representatives": [
            {
                "id": "9d2e5c8a-1234-5678-9abc-def012345679",
                "reference": "ABC123",
                "name": "Jane Doe"
            }
        ]
    }
}

Create a new company

POST

https://partners.staging.goescrow.net

/api/v1/companies

requires authentication

Creates a new company and attaches one or more existing users as its representatives.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

Ignored when supplied; the company name is sourced from the Australian Business Register

Example:

Acme Corp Pty Ltd

abn

string

required

Australian Business Number

Example:

40650703736

acn

string

Australian Company Number

Example:

004085616

string

Company email address

Example:

info@acmecorp.com.au

phone

string

Company phone number in international format

Example:

+61298765432

website

string

Company website URL

Example:

https://www.acmecorp.com.au

type

string

Company type/structure; sourced from the Australian Business Register when available

Example:

Proprietary Limited

majority_owned_by_another_australian_company

boolean

required

Whether the company is majority owned by another Australian company

Example:

false

majority_owned_by_overseas_person_or_company

boolean

required

Whether the company is majority owned by an overseas person or company

Example:

false

majority_owned_by_listed_australian_company

boolean

required

Whether the company is majority owned by a listed Australian company

Example:

false

acting_as_trustee_for_a_trust

boolean

required

Whether the company is acting as trustee for a trust

Example:

false

representatives

string[]

required

Existing user UUIDs to attach as company representatives

Example:

["9d2e5c8a-1234-5678-9abc-def012345678"]

address

object

The company's address. All fields are optional.

Example:

{"unit_number":"3","street_number":"20","street":"Company Street","suburb":"Melbourne","state":"VIC","postcode":"3000","country":"Australia"}

Response Fields

data

object

The unique identifier of the company

required

reference

The unique reference code for the company (GoEscrow ID)

required

name

The company name

required

abn

The Australian Business Number

required

acn

The Australian Company Number

required

kyb_verified

Whether the company has completed KYB verification

required

aml_verified

Whether the company has completed AML verification

required

aml_verified_at

Timestamp when the company completed AML verification

required

bank_verified

Whether the company has a verified bank account

required

abr_status

The status from the latest Australian Business Register lookup

required

representatives

The company representatives

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/companies" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Acme Corp Pty Ltd\",
    \"abn\": \"40650703736\",
    \"acn\": \"004085616\",
    \"email\": \"info@acmecorp.com.au\",
    \"phone\": \"+61298765432\",
    \"website\": \"https:\\/\\/www.acmecorp.com.au\",
    \"type\": \"Proprietary Limited\",
    \"majority_owned_by_another_australian_company\": false,
    \"majority_owned_by_overseas_person_or_company\": false,
    \"majority_owned_by_listed_australian_company\": false,
    \"acting_as_trustee_for_a_trust\": false,
    \"representatives\": [
        \"9d2e5c8a-1234-5678-9abc-def012345678\"
    ],
    \"address\": {
        \"unit_number\": \"3\",
        \"street_number\": \"20\",
        \"street\": \"Company Street\",
        \"suburb\": \"Melbourne\",
        \"state\": \"VIC\",
        \"postcode\": \"3000\",
        \"country\": \"Australia\"
    }
}"

Example response:

{
    "data": {
        "id": "comp_123",
        "reference": "ABC123",
        "name": "Acme Corp Pty Ltd",
        "abn": "40650703736",
        "acn": "004085616",
        "kyb_verified": true,
        "aml_verified": true,
        "aml_verified_at": "2026-06-25T00:00:00.000000Z",
        "bank_verified": true,
        "abr_status": "Active",
        "representatives": [
            {
                "id": "9d2e5c8a-1234-5678-9abc-def012345678",
                "reference": "ABC123",
                "name": "Jane Doe"
            }
        ]
    }
}

Update a company

PUT

PATCH

https://partners.staging.goescrow.net

/api/v1/companies/{id}

requires authentication

Updates an existing company. Only provided fields will be updated. ABN must be omitted, even when unchanged; create a new company for a different ABN.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

company_id

string

required

The company UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

name

string

The company name

Example:

Acme Corp Pty Ltd

acn

string

Australian Company Number

Example:

004085616

string

Company email address

Example:

info@acmecorp.com.au

phone

string

Company phone number in international format

Example:

+61298765432

website

string

Company website URL

Example:

https://www.acmecorp.com.au

type

string

Company type/structure

Example:

Proprietary Limited

majority_owned_by_another_australian_company

boolean

Whether the company is majority owned by another Australian company

Example:

false

majority_owned_by_overseas_person_or_company

boolean

Whether the company is majority owned by an overseas person or company

Example:

false

majority_owned_by_listed_australian_company

boolean

Whether the company is majority owned by a listed Australian company

Example:

false

acting_as_trustee_for_a_trust

boolean

Whether the company is acting as trustee for a trust

Example:

false

add_representatives

string[]

User UUIDs to attach as company representatives

Example:

["9d2e5c8a-1234-5678-9abc-def012345678"]

remove_representatives

string[]

User UUIDs to detach as company representatives

Example:

["9d2e5c8a-1234-5678-9abc-def012345679"]

address

object

The company's address. All fields are optional.

Example:

{"unit_number":"3","street_number":"20","street":"Company Street","suburb":"Melbourne","state":"VIC","postcode":"3000","country":"Australia"}

Response Fields

data

object

The unique identifier of the company

required

reference

The unique reference code for the company (GoEscrow ID)

required

name

The company name

required

abn

The Australian Business Number

required

acn

The Australian Company Number

required

kyb_verified

Whether the company has completed KYB verification

required

aml_verified

Whether the company has completed AML verification

required

aml_verified_at

Timestamp when the company completed AML verification

required

bank_verified

Whether the company has a verified bank account

required

abr_status

The status from the latest Australian Business Register lookup

required

representatives

The company representatives

required

Example request:

curl --request PUT \
    "https://partners.staging.goescrow.net/api/v1/companies/1" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Acme Corp Pty Ltd\",
    \"acn\": \"004085616\",
    \"email\": \"info@acmecorp.com.au\",
    \"phone\": \"+61298765432\",
    \"website\": \"https:\\/\\/www.acmecorp.com.au\",
    \"type\": \"Proprietary Limited\",
    \"majority_owned_by_another_australian_company\": false,
    \"majority_owned_by_overseas_person_or_company\": false,
    \"majority_owned_by_listed_australian_company\": false,
    \"acting_as_trustee_for_a_trust\": false,
    \"add_representatives\": [
        \"9d2e5c8a-1234-5678-9abc-def012345678\"
    ],
    \"remove_representatives\": [
        \"9d2e5c8a-1234-5678-9abc-def012345679\"
    ],
    \"address\": {
        \"unit_number\": \"3\",
        \"street_number\": \"20\",
        \"street\": \"Company Street\",
        \"suburb\": \"Melbourne\",
        \"state\": \"VIC\",
        \"postcode\": \"3000\",
        \"country\": \"Australia\"
    }
}"

Example response:

{
    "data": {
        "id": "comp_123",
        "reference": "ABC123",
        "name": "Acme Corp Pty Ltd",
        "abn": "40650703736",
        "acn": "004085616",
        "kyb_verified": true,
        "aml_verified": true,
        "aml_verified_at": "2026-06-25T00:00:00.000000Z",
        "bank_verified": true,
        "abr_status": "Active",
        "representatives": [
            {
                "id": "9d2e5c8a-1234-5678-9abc-def012345678",
                "reference": "ABC123",
                "name": "Jane Doe"
            }
        ]
    }
}

Upload company files

POST

https://partners.staging.goescrow.net

/api/v1/companies/{company_id}/files

requires authentication

Uploads one or more files to a company filing cabinet. The authenticated partner must represent the company.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

company_id

string

required

The company UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

files

file[]

required

One or more files to upload.

Example:

Response Fields

data

object

The company file ID

required

file

The private storage path

required

filename

The original uploaded filename

required

created_at

The upload timestamp

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/companies/9d2e5c8a-1234-5678-9abc-def012345678/files" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "files[]=@/tmp/phpq49sfpgbkkildILogIl"

Example response:

{
    "data": [
        {
            "id": "9d2e5c8a-1234-5678-9abc-def012345678",
            "file": "a1b2c3d4/document.pdf",
            "filename": "document.pdf",
            "created_at": "2024-01-15T10:30:00Z"
        }
    ]
}

User Management

Manage Users

Create a new user

POST

https://partners.staging.goescrow.net

/api/v1/users

requires authentication

Creates a new user. Email and phone must be unique. The user will be automatically associated with the authenticated partner. If the authenticated Partner has welcome emails enabled, newly created API users receive a GoEscrow Welcome By Partner email with a 24-hour, single-use password setup link.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

first_name

string

required

The user's first name

Example:

John

last_name

string

required

The user's last name

Example:

Doe

string

required

The user's email address. Must be a valid email format.

Example:

john.doe@example.com

phone

string

required

The user's phone number. Must be a valid Australian phone number (e.g., 0412345678, +61412345678, or 61412345678).

Example:

+61412345678

birth_date

string

The user's date of birth in YYYY-MM-DD format. Optional.

Example:

1990-01-15

initiate_mobile_verification_flow

string

Whether to send the KYC ID scanner to the user mobile. Accepts yes or no and defaults to no.

Example:

yes

address

object

The user's address. Optional.

Example:

{"unit_number":"10B","street_number":"123","street":"Smith St","suburb":"Sydney","state":"NSW","postcode":"2000"}

Response Fields

data

object

The unique identifier of the user

required

reference

The unique reference code for the user (GoEscrow ID)

required

first_name

The user's first name

required

last_name

The user's last name

required

The user's email address

required

phone

The user's phone number in E.164 format

required

birth_date

The user's date of birth

required

kyc_verified

Whether the user has completed KYC verification

required

aml_verified

Whether the user has completed AML verification

required

aml_verified_at

Timestamp when the user completed AML verification

required

email_verified

Whether the user has verified their email

required

mobile_verified

Whether the user has verified their mobile

required

mobilekyc_verified

Whether the user has completed mobile KYC verification

required

bank_verified

Whether the user has verified their bank account

required

suspended

Whether the user account is suspended

required

address

The user's address (null if not set)

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/users" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"John\",
    \"last_name\": \"Doe\",
    \"email\": \"john.doe@example.com\",
    \"phone\": \"+61412345678\",
    \"birth_date\": \"1990-01-15\",
    \"initiate_mobile_verification_flow\": \"yes\",
    \"address\": {
        \"unit_number\": \"10B\",
        \"street_number\": \"123\",
        \"street\": \"Smith St\",
        \"suburb\": \"Sydney\",
        \"state\": \"NSW\",
        \"postcode\": \"2000\"
    }
}"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "reference": "ABC123",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@example.com",
        "phone": "+61412345678",
        "birth_date": "1990-01-15",
        "kyc_verified": false,
        "aml_verified": false,
        "aml_verified_at": null,
        "email_verified": false,
        "mobile_verified": false,
        "mobilekyc_verified": false,
        "bank_verified": false,
        "suspended": false,
        "address": {
            "unit_number": "10B",
            "street_number": "123",
            "street": "Smith St",
            "suburb": "Sydney",
            "state": "NSW",
            "postcode": "2000",
            "country": "Australia"
        }
    }
}

Update a user

PUT

PATCH

https://partners.staging.goescrow.net

/api/v1/users/{id}

requires authentication

Updates an existing user for the authenticated partner. Email and phone must remain unique.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

first_name

string

The user's first name

Example:

John

last_name

string

The user's last name

Example:

Doe

string

The user's email address. Must be a valid email format.

Example:

john.doe@example.com

phone

string

The user's phone number. Must be a valid Australian phone number (e.g., 0412345678, +61412345678, or 61412345678).

Example:

+61412345678

birth_date

string

The user's date of birth in YYYY-MM-DD format. Optional.

Example:

1990-01-15

address

object

The user's address. Optional.

Example:

{"unit_number":"10B","street_number":"123","street":"Smith St","suburb":"Sydney","state":"NSW","postcode":"2000"}

Example request:

curl --request PUT \
    "https://partners.staging.goescrow.net/api/v1/users/1" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"John\",
    \"last_name\": \"Doe\",
    \"email\": \"john.doe@example.com\",
    \"phone\": \"+61412345678\",
    \"birth_date\": \"1990-01-15\",
    \"address\": {
        \"unit_number\": \"10B\",
        \"street_number\": \"123\",
        \"street\": \"Smith St\",
        \"suburb\": \"Sydney\",
        \"state\": \"NSW\",
        \"postcode\": \"2000\"
    }
}"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "reference": "ABC123",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@example.com",
        "phone": "+61412345678",
        "birth_date": "1990-01-15",
        "kyc_verified": false,
        "aml_verified": false,
        "aml_verified_at": null,
        "email_verified": false,
        "mobile_verified": false,
        "mobilekyc_verified": false,
        "bank_verified": false,
        "suspended": false,
        "address": {
            "unit_number": "10B",
            "street_number": "123",
            "street": "Smith St",
            "suburb": "Sydney",
            "state": "NSW",
            "postcode": "2000",
            "country": "Australia"
        }
    }
}

Lookup user or company

GET

https://partners.staging.goescrow.net

/api/v1/users/lookup

requires authentication

Look up an existing user by email, phone, or GoEscrow reference. Company reference matches return only the company name and reference. Exactly one parameter must be provided.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

string

The user's email address. Supply exactly one of email, phone, or reference.

Example:

john.doe@example.com

phone

string

The user's phone number. Supply exactly one of email, phone, or reference. Accepts 0412345678, +61412345678, or 61412345678.

Example:

+61412345678

reference

string

A user or company GoEscrow reference. Supply exactly one of email, phone, or reference.

Example:

ABC123

Response Fields

data

object

The unique identifier of the user

required

reference

The unique reference code for the user (GoEscrow ID)

required

first_name

The user's first name

required

last_name

The user's last name

required

The user's email address

required

phone

The user's phone number in E.164 format

required

birth_date

The user's date of birth

required

kyc_verified

Whether the user has completed KYC verification

required

aml_verified

Whether the user has completed AML verification

required

aml_verified_at

Timestamp when the user completed AML verification

required

email_verified

Whether the user has verified their email

required

mobile_verified

Whether the user has verified their mobile

required

mobilekyc_verified

Whether the user has completed mobile KYC verification

required

bank_verified

Whether the user has verified their bank account

required

suspended

Whether the user account is suspended

required

address

The user's address (null if not set)

required

name

The company name (company reference lookups only)

required

Example request:

curl --request GET \
    --get "https://partners.staging.goescrow.net/api/v1/users/lookup?email=john.doe%40example.com&phone=%2B61412345678&reference=ABC123" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "reference": "ABC123",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@example.com",
        "phone": "+61412345678",
        "birth_date": "1990-01-15",
        "kyc_verified": true,
        "aml_verified": true,
        "aml_verified_at": "2026-06-25T00:00:00.000000Z",
        "email_verified": true,
        "mobile_verified": true,
        "mobilekyc_verified": true,
        "bank_verified": true,
        "suspended": false,
        "address": {
            "unit_number": "1",
            "street_number": "123",
            "street": "Main Street",
            "suburb": "Sydney",
            "state": "NSW",
            "postcode": "2000",
            "country": "Australia"
        }
    }
}

Send mobile verification code

GET

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/verify-mobile

requires authentication

Sends a verification code via SMS to the user's registered phone number. The code will be valid for a limited time.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Example request:

curl --request GET \
    --get "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/verify-mobile" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Verify mobile phone

POST

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/verify-mobile

requires authentication

Verifies the mobile phone number using the code sent via SMS. Upon successful verification, the user's phone will be marked as verified.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

code

string

required

The verification code received via SMS

Example:

123456

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/verify-mobile" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"123456\"
}"

Example response:

[Empty response]

Send email verification code

GET

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/verify-email

requires authentication

Sends a verification code via email to the user's registered email address. The code will be valid for a limited time.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Example request:

curl --request GET \
    --get "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/verify-email" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Verify email address

POST

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/verify-email

requires authentication

Verifies the email address using the code sent via email. Upon successful verification, the user's email will be marked as verified.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

code

string

required

The verification code received via email

Example:

123456

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/verify-email" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"123456\"
}"

Example response:

[Empty response]

Generate user bank statement

GET

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/bank-statement

requires authentication

Generates and returns a PDF bank statement for the specified user. The statement includes transaction history and account details.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Example request:

curl --request GET \
    --get "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/bank-statement" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[]

Upload user files

POST

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/files

requires authentication

Uploads one or more files to a user filing cabinet. The authenticated partner must own the user.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

files

file[]

required

One or more files to upload.

Example:

Response Fields

data

object

The user file ID

required

file

The private storage path

required

filename

The original uploaded filename

required

created_at

The upload timestamp

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/files" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "files[]=@/tmp/php87mnhuep7j1gaAIfEno"

Example response:

{
    "data": [
        {
            "id": "9d2e5c8a-1234-5678-9abc-def012345678",
            "file": "a1b2c3d4/document.pdf",
            "filename": "document.pdf",
            "created_at": "2024-01-15T10:30:00Z"
        }
    ]
}

Generate password reset link

POST

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/password-reset-link

requires authentication

Generates a short-lived password reset link for the user.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

send_email

boolean

If true, sends a password reset email to the user.

Example:

true

Response Fields

reset_url

The password reset URL

required

expires_in

Link expiry time

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/password-reset-link" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"send_email\": true
}"

Example response:

{
    "reset_url": "https://app.goescrow.com.au/auth/forgot-password/abc123",
    "expires_in": "60 minutes"
}

Dispute Management

Create and manage transaction disputes

Create a dispute

POST

https://partners.staging.goescrow.net

/api/v1/disputes

requires authentication

Creates a dispute for a transaction. This will mark the transaction as disputed and create a compliance note for the CS team to review.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Idempotency-Key

Example:

6f3a8e1c-9b2d-4f5a-8c1e-2a7b9d0e1f23

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

requester_id

string

required

The ID of the user raising the dispute

Example:

9d2e5c8a-1234-5678-9abc-def012345678

requester_role

string

required

The role of the requester: buyer or seller

Must be one of:

buyer
seller

Example:

buyer

transaction_id

string

required

The transaction ID

Example:

9d2e5c8a-1234-5678-9abc-def012345678

request_type

string

required

The type of request: pause, settle_to_requester, split, other

Must be one of:

pause
settle_to_requester
split
other

Example:

pause

issue_description

string

required

Detailed description of the issue

Example:

The goods were not delivered as described.

Response Fields

message

Status message

required

dispute_reference

The compliance note reference for tracking

required

transaction_id

The transaction ID

required

status

The new transaction status

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/disputes" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Idempotency-Key: 6f3a8e1c-9b2d-4f5a-8c1e-2a7b9d0e1f23" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"requester_id\": \"9d2e5c8a-1234-5678-9abc-def012345678\",
    \"requester_role\": \"buyer\",
    \"transaction_id\": \"9d2e5c8a-1234-5678-9abc-def012345678\",
    \"request_type\": \"pause\",
    \"issue_description\": \"The goods were not delivered as described.\"
}"

Example response:

{
    "message": "Dispute created successfully.",
    "dispute_reference": "DISP-2024-001234",
    "transaction_id": "9d2e5c8a-1234-5678-9abc-def012345678",
    "status": "disputed"
}

Transaction Cancellation

Manage cancellation requests and approvals for partner transactions.

Multiple payees: non-marketplace Anytime and Timed transactions

A transaction with two or more disbursement entries uses per-party cancellation approval. The API derives the parties from the saved payer and disbursement recipients. Do not include a list of other parties or resend the disbursement array in cancellation requests. All calls below use the existing /api/v1/transactions/{transaction_id} endpoints.

POST /cancellation-request with requester_id, the requesting user or company UUID. For a company with multiple representatives, also send representative_id, the UUID of the linked user acting for that company. Use the same representative for code delivery and verification.
If requires_2fa is true, codes have been sent but the request has not yet been created. POST /verify-cancellation with the same actor details, email_code and phone_code to create it.
Save the returned cancellation_request_id. Each other party POSTs /cancellation-accept with its own accepter_id, the current cancellation_request_id and, where needed, representative_id.
If acceptance returns requires_2fa: true, that party POSTs /verify-cancellation-accept with the same actor details and request ID, plus email_code and phone_code.
A party still requiring approval can instead POST /cancellation-deny with denier_id, the current cancellation_request_id and, where needed, representative_id. Denial does not require verification codes.

For example, an individual requests cancellation without listing the other parties:

{"requester_id": "9d2e5c8a-1234-5678-9abc-def012345678"}

After the request is created, another party accepts using the returned request ID:

{"accepter_id": "9d2e5c8a-1234-5678-9abc-def012345680", "cancellation_request_id": "2c9bb6a0-b123-4567-89ab-0123456789ab"}

The requester contributes the first approval. With one payer and two distinct payees, all three legal parties must approve; one representative acting for two companies must approve separately for each company. An HTTP 200 can mean only that one approval was recorded. The transaction remains cancellation_requested until all required approvals are complete. Check status for canceled; refund processing may still be pending.

Pending multi-payee transactions also require all parties to approve; they are not cancelled immediately. Partially or fully funded multi-payee transactions require email and phone verification for every approval, based on positive, unreversed payment receipts. If funding arrives after an unverified approval, that party must approve again with verification. Codes expire after five minutes and are bound to the transaction, legal party, representative and cancellation attempt.

A missing or stale cancellation_request_id on acceptance, acceptance verification or denial returns HTTP 422. Refresh the transaction and use the current ID; do not replay an old approval against a new request. The response ID is null before a request is created and after cancellation or denial ends it. Older active requests without a generated ID return legacy; send the returned value unchanged.

Denial normally restores the previous status. For a multi-payee Timed transaction less than 12 hours before a future release, denial instead sets contact_helpdesk, suspends payee settlements and alerts customer service.

Single-payee and marketplace transactions retain their existing cancellation flow. The multi-payee-only fields and approval rules below do not change that flow.

Request transaction cancellation

POST

https://partners.staging.goescrow.net

/api/v1/transactions/{transaction_id}/cancellation-request

requires authentication

Initiates cancellation. For non-marketplace multi-payee Anytime and Timed transactions, supply only the requesting party ID and, when needed, its representative ID; the API already knows the other parties. Unfunded pending or accepted transactions enter cancellation_requested with the requester approval recorded. If requires_2fa is true, call verify-cancellation to create the request. Single-payee pending transactions retain immediate cancellation; accepted transactions retain the existing counterparty flow.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Idempotency-Key

Example:

6f3a8e1c-9b2d-4f5a-8c1e-2a7b9d0e1f23

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

transaction_id

string

required

The transaction UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

requester_id

string

required

The user or company legal-party ID requesting cancellation

Example:

9d2e5c8a-1234-5678-9abc-def012345678

representative_id

string

Multi-payee only: UUID of a current representative of the acting company. Required when the company has multiple representatives; optional when exactly one exists. Use the same representative for code delivery and verification. Omit for an individual party.

Example:

9d2e5c8a-1234-5678-9abc-def012345679

Response Fields

message

string

required

Status message. Use status and requires_2fa to decide the next step.

requires_2fa

boolean

required

Whether codes were sent and the corresponding verification endpoint must be called before recording this approval.

transaction_id

string

required

The transaction UUID.

status

string

required

Current transaction status. For multi-payee transactions, cancellation_requested can mean that further approvals remain; canceled means cancellation completed.

cancellation_request_id

string

Multi-payee only: current cancellation attempt ID while status is cancellation_requested; null otherwise. Single-payee responses omit this field.

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/transactions/9d2e5c8a-1234-5678-9abc-def012345678/cancellation-request" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Idempotency-Key: 6f3a8e1c-9b2d-4f5a-8c1e-2a7b9d0e1f23" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"requester_id\": \"9d2e5c8a-1234-5678-9abc-def012345678\",
    \"representative_id\": \"9d2e5c8a-1234-5678-9abc-def012345679\"
}"

Example response:

{
    "message": "Cancellation requested. 2FA verification required. Codes sent to requester's email and phone.",
    "requires_2fa": true,
    "transaction_id": "9d2e5c8a-1234-5678-9abc-def012345678",
    "status": "accepted"
}

Verify cancellation request 2FA codes

POST

https://partners.staging.goescrow.net

/api/v1/transactions/{transaction_id}/verify-cancellation

requires authentication

Verifies requester codes and creates the cancellation request. For multi-payee transactions, this records only the requester approval and returns cancellation_request_id for the remaining parties. Use the same requester_id and representative_id as the code-delivery call. No cancellation_request_id is needed to create the request.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

transaction_id

string

required

The transaction UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

requester_id

string

required

The user or company legal-party ID requesting cancellation

Example:

9d2e5c8a-1234-5678-9abc-def012345678

email_code

string

required

The 6-digit code sent to email

Example:

123456

phone_code

string

required

The 6-digit code sent to phone

Example:

654321

representative_id

string

Example:

9d2e5c8a-1234-5678-9abc-def012345679

Response Fields

message

string

required

Status message. Use status and requires_2fa to decide the next step.

requires_2fa

boolean

required

Whether codes were sent and the corresponding verification endpoint must be called before recording this approval.

transaction_id

string

required

The transaction UUID.

status

string

required

Current transaction status. For multi-payee transactions, cancellation_requested can mean that further approvals remain; canceled means cancellation completed.

cancellation_request_id

string

Multi-payee only: current cancellation attempt ID while status is cancellation_requested; null otherwise. Single-payee responses omit this field.

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/transactions/9d2e5c8a-1234-5678-9abc-def012345678/verify-cancellation" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"requester_id\": \"9d2e5c8a-1234-5678-9abc-def012345678\",
    \"email_code\": \"123456\",
    \"phone_code\": \"654321\",
    \"representative_id\": \"9d2e5c8a-1234-5678-9abc-def012345679\"
}"

Example response:

{
    "message": "Cancellation requested. Waiting for counterparty response.",
    "requires_2fa": false,
    "transaction_id": "9d2e5c8a-1234-5678-9abc-def012345678",
    "status": "cancellation_requested"
}

Accept transaction cancellation

POST

https://partners.staging.goescrow.net

/api/v1/transactions/{transaction_id}/cancellation-accept

requires authentication

Records approval from one outstanding party. Multi-payee requests require the current cancellation_request_id. If requires_2fa is true, codes were sent but approval is not yet recorded: call verify-cancellation-accept. Otherwise HTTP 200 may still have status cancellation_requested while other approvals are outstanding. Only the final required approval completes cancellation. Single-payee requests retain the existing counterparty flow.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

transaction_id

string

required

The transaction UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

accepter_id

string

required

The user or company legal-party ID accepting cancellation

Example:

9d2e5c8a-1234-5678-9abc-def012345678

representative_id

string

Example:

9d2e5c8a-1234-5678-9abc-def012345679

cancellation_request_id

string

Required for multi-payee cancellation responses: the current ID returned when the cancellation request was created or read from the transaction. Missing or stale IDs return 422. Not required for single-payee transactions.

Example:

2c9bb6a0-b123-4567-89ab-0123456789ab

Response Fields

message

string

required

Status message. Use status and requires_2fa to decide the next step.

requires_2fa

boolean

required

Whether codes were sent and the corresponding verification endpoint must be called before recording this approval.

transaction_id

string

required

The transaction UUID.

status

string

required

Current transaction status. For multi-payee transactions, cancellation_requested can mean that further approvals remain; canceled means cancellation completed.

cancellation_request_id

string

Multi-payee only: current cancellation attempt ID while status is cancellation_requested; null otherwise. Single-payee responses omit this field.

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/transactions/9d2e5c8a-1234-5678-9abc-def012345678/cancellation-accept" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"accepter_id\": \"9d2e5c8a-1234-5678-9abc-def012345678\",
    \"representative_id\": \"9d2e5c8a-1234-5678-9abc-def012345679\",
    \"cancellation_request_id\": \"2c9bb6a0-b123-4567-89ab-0123456789ab\"
}"

Example response:

{
    "message": "Cancellation acceptance requires 2FA verification. Codes sent to accepter's email and phone.",
    "requires_2fa": true,
    "transaction_id": "9d2e5c8a-1234-5678-9abc-def012345678",
    "status": "cancellation_requested"
}

Verify cancellation acceptance 2FA codes

POST

https://partners.staging.goescrow.net

/api/v1/transactions/{transaction_id}/verify-cancellation-accept

requires authentication

Verifies one party approval using email_code and phone_code. For multi-payee transactions, include the current cancellation_request_id and use the same accepter_id and representative_id as the code-delivery call. Cancellation remains pending until the payer and every payee have approved with any required verification.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

transaction_id

string

required

The transaction UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

accepter_id

string

required

The user or company legal-party ID accepting cancellation

Example:

9d2e5c8a-1234-5678-9abc-def012345678

email_code

string

required

The 6-digit code sent to email

Example:

123456

phone_code

string

required

The 6-digit code sent to phone

Example:

654321

representative_id

string

Example:

9d2e5c8a-1234-5678-9abc-def012345679

cancellation_request_id

string

Example:

2c9bb6a0-b123-4567-89ab-0123456789ab

Response Fields

message

string

required

Status message. Use status and requires_2fa to decide the next step.

requires_2fa

boolean

required

Whether codes were sent and the corresponding verification endpoint must be called before recording this approval.

transaction_id

string

required

The transaction UUID.

status

string

required

Current transaction status. For multi-payee transactions, cancellation_requested can mean that further approvals remain; canceled means cancellation completed.

cancellation_request_id

string

Multi-payee only: current cancellation attempt ID while status is cancellation_requested; null otherwise. Single-payee responses omit this field.

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/transactions/9d2e5c8a-1234-5678-9abc-def012345678/verify-cancellation-accept" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"accepter_id\": \"9d2e5c8a-1234-5678-9abc-def012345678\",
    \"email_code\": \"123456\",
    \"phone_code\": \"654321\",
    \"representative_id\": \"9d2e5c8a-1234-5678-9abc-def012345679\",
    \"cancellation_request_id\": \"2c9bb6a0-b123-4567-89ab-0123456789ab\"
}"

Example response:

{
    "message": "Cancellation accepted. Transaction cancelled successfully.",
    "requires_2fa": false,
    "transaction_id": "9d2e5c8a-1234-5678-9abc-def012345678",
    "status": "canceled"
}

Deny transaction cancellation

POST

https://partners.staging.goescrow.net

/api/v1/transactions/{transaction_id}/cancellation-deny

requires authentication

Denies an active cancellation request without verification codes. For multi-payee transactions, only a party still requiring approval may deny; supply the current cancellation_request_id. Normally restores the previous status. Within 12 hours before a future Timed release, multi-payee denial instead sets contact_helpdesk, suspends payee settlements and alerts customer service. Single-payee requests retain their existing denial flow.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

transaction_id

string

required

The transaction UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

denier_id

string

required

The user or company legal-party ID denying cancellation

Example:

9d2e5c8a-1234-5678-9abc-def012345678

representative_id

string

Example:

9d2e5c8a-1234-5678-9abc-def012345679

cancellation_request_id

string

Example:

2c9bb6a0-b123-4567-89ab-0123456789ab

Response Fields

message

string

required

Status message. Use status and requires_2fa to decide the next step.

requires_2fa

boolean

required

Whether codes were sent and the corresponding verification endpoint must be called before recording this approval.

transaction_id

string

required

The transaction UUID.

status

string

required

Current transaction status. For multi-payee transactions, cancellation_requested can mean that further approvals remain; canceled means cancellation completed.

cancellation_request_id

string

Multi-payee only: current cancellation attempt ID while status is cancellation_requested; null otherwise. Single-payee responses omit this field.

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/transactions/9d2e5c8a-1234-5678-9abc-def012345678/cancellation-deny" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"denier_id\": \"9d2e5c8a-1234-5678-9abc-def012345678\",
    \"representative_id\": \"9d2e5c8a-1234-5678-9abc-def012345679\",
    \"cancellation_request_id\": \"2c9bb6a0-b123-4567-89ab-0123456789ab\"
}"

Example response:

{
    "message": "Cancellation denied. Transaction reverted to active status.",
    "transaction_id": "9d2e5c8a-1234-5678-9abc-def012345678",
    "status": "accepted"
}

Transaction Management

Manage Transactions

Create transaction

POST

https://partners.staging.goescrow.net

/api/v1/transactions

requires authentication

Creates a new escrow transaction with disbursements. Partner API transactions are auto-accepted (skip pending status).

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Idempotency-Key

Example:

6f3a8e1c-9b2d-4f5a-8c1e-2a7b9d0e1f23

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

action

string

required

Transaction direction: buy (payer) or sell (requester).

Example:

buy

type

string

required

Transaction type: anytime_escrow or timed_escrow.

Example:

anytime_escrow

amount_type

string

required

Indicates whether amount is escrow (gross) or settlement (net).

Example:

escrow

other_user

string

Counterparty user ID for standard escrow. Exactly one of other_user or other_company_id is required when disbursements are omitted.

Example:

9d2e5c8a-1234-5678-9abc-def012345678

other_company_id

string

Counterparty company ID for standard escrow. The company must be accessible to the partner and eligible to transact.

Example:

9d2e5c8a-1234-5678-9abc-def012345678

sub_type

string

The transaction sub type (optional: omit or null for plain anytime escrow, marketplace for marketplace-controlled settlement)

Example:

marketplace

user_id

string

required

The ID of the buyer/payer

Example:

9d2e5c8a-1234-5678-9abc-def012345678

company_id

string

Source legal-party company ID. The user_id must be its representative. Required for super_disbursement and must then match the partner associated company.

Example:

9d2e5c8a-1234-5678-9abc-def012345678

marketplace_operator_id

string

The partner ID of the marketplace operator who can trigger settlement (required for marketplace sub_type)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

release_at

string

The date/time for auto-release (creates timed escrow). ISO 8601 format. Required when type is timed_escrow.

Example:

2024-12-31T23:59:59Z

details

string

required

Transaction details and description

Example:

Dental Surgery

amount

integer

required

Total transaction amount in cents (e.g., 15000050 for $150,000.50)

Example:

15000050

disbursements

string[]

Array of disbursement objects (required for super_disbursement). Omit for standard escrow to allocate automatically to other_user or other_company_id.

object

beneficiaries

object[]

Beneficiaries to attach to the transaction. Only valid when sub_type is marketplace.

first_name

string

required

The beneficiary first name (maximum 100 characters).

Example:

Greg

last_name

string

required

The beneficiary last name (maximum 100 characters).

Example:

Recipient

mobile

string

required

A valid Australian mobile number. A beneficiary mobile cannot belong to a transaction party or the marketplace operator.

Example:

+61400000001

required

boolean

Whether the beneficiary is required for settlement. Defaults to true. An optional beneficiary who declines still blocks settlement.

Example:

true

Response Fields

data

object

Transaction ID

required

reference

Transaction reference code

required

type

Transaction type (anytime_escrow|timed_escrow)

required

sub_type

Transaction sub type (null, marketplace, super_disbursement)

required

status

Transaction status

required

funding_status

Funding status

required

amount

object

details

Transaction details/description

required

release_at

Auto-release datetime (ISO8601) for timed escrow

required

created_at

Creation datetime (ISO8601)

required

buyer_id

Buyer user ID

required

seller_id

Seller user ID (counterparty)

required

other_party_hint

Masked counterparty name for display

required

funding_details

Funding instructions (EFT/PayID)

required

beneficiaries

Masked beneficiaries attached to the transaction (id, first_name, last_name, mobile, required, status)

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/transactions" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Idempotency-Key: 6f3a8e1c-9b2d-4f5a-8c1e-2a7b9d0e1f23" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"action\": \"buy\",
    \"type\": \"anytime_escrow\",
    \"amount_type\": \"escrow\",
    \"other_user\": \"9d2e5c8a-1234-5678-9abc-def012345678\",
    \"other_company_id\": \"9d2e5c8a-1234-5678-9abc-def012345678\",
    \"sub_type\": \"marketplace\",
    \"user_id\": \"9d2e5c8a-1234-5678-9abc-def012345678\",
    \"company_id\": \"9d2e5c8a-1234-5678-9abc-def012345678\",
    \"marketplace_operator_id\": \"9d2e5c8a-1234-5678-9abc-def012345678\",
    \"release_at\": \"2024-12-31T23:59:59Z\",
    \"details\": \"Dental Surgery\",
    \"amount\": 15000050,
    \"disbursements\": [
        \"fugit\"
    ],
    \"beneficiaries\": [
        {
            \"first_name\": \"Greg\",
            \"last_name\": \"Recipient\",
            \"mobile\": \"+61400000001\",
            \"required\": true
        }
    ]
}"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "reference": "TXN-2024-001234",
        "type": "anytime_escrow",
        "sub_type": "marketplace",
        "status": "accepted",
        "funding_status": "pending",
        "amount": 150000.5,
        "details": "Property settlement for 123 Main St",
        "created_at": "2024-01-15T10:30:00Z",
        "beneficiaries": [
            {
                "id": "9d2e5c8a-1234-5678-9abc-def012345679",
                "first_name": "G**g",
                "last_name": "R*******t",
                "mobile": "+61******001",
                "required": true,
                "status": "pending"
            }
        ]
    }
}

Get transaction status by identifier

GET

https://partners.staging.goescrow.net

/api/v1/transactions/status

requires authentication

Returns full transaction details including funding information. Provide exactly one of transaction_id or reference_id. Requires party_id to verify access.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

transaction_id

string

The transaction UUID (36-character internal identifier). Required when reference_id is not provided. Must not be provided with reference_id.

Example:

9d2e5c8a-1234-5678-9abc-def012345678

reference_id

string

The transaction reference number. Required when transaction_id is not provided. Must not be provided with transaction_id.

Example:

TXN-2024-001234

party_id

string

required

The ID of the buyer, seller, or disbursement recipient to verify access

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

transaction_id

string

This field is required when reference_id is not present. Must be a valid UUID.

Example:

4b3f9a1c-0e69-32e3-90a4-369d7ca4699f

reference_id

string

This field is required when transaction_id is not present.

Example:

party_id

string

required

Must be a valid UUID.

Example:

609298a8-62fe-3779-9328-1ed7e3ca5d01

Example request:

curl --request GET \
    --get "https://partners.staging.goescrow.net/api/v1/transactions/status?transaction_id=9d2e5c8a-1234-5678-9abc-def012345678&reference_id=TXN-2024-001234&party_id=9d2e5c8a-1234-5678-9abc-def012345678" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"transaction_id\": \"4b3f9a1c-0e69-32e3-90a4-369d7ca4699f\",
    \"reference_id\": \"et\",
    \"party_id\": \"609298a8-62fe-3779-9328-1ed7e3ca5d01\"
}"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "reference": "TXN-2024-001234",
        "type": "anytime_escrow",
        "sub_type": "marketplace",
        "status": "accepted",
        "funding_status": "pending",
        "amount": 150000.5,
        "fee": 1500,
        "amount_with_fee": 151500.5,
        "details": "Property settlement",
        "release_at": null,
        "created_at": "2024-01-15T10:30:00Z",
        "buyer_id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "buyer_reference": "ABC123",
        "seller_id": "9d2e5c8a-1234-5678-9abc-def012345679",
        "seller_reference": "XYZ789",
        "other_party_hint": "J*** D***",
        "funding_details": {
            "bsb": "123456",
            "account_number": "12345678",
            "account_name": "GoEscrow Trust",
            "pay_id": "pay@goescrow.com.au",
            "reference": "TXN-2024-001234",
            "rail": "azupay",
            "account_scope": "transaction",
            "payment_reference": "TXN-2024-001234",
            "reference_required": false,
            "provisioning_status": "ready",
            "amount_received": "0.00",
            "amount_outstanding": "151500.50"
        }
    }
}

Get transaction status

GET

https://partners.staging.goescrow.net

/api/v1/transactions/{id}

requires authentication

Returns full transaction details including funding information. Requires party_id to verify access.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

transaction_id

string

required

The transaction UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Query Parameters

party_id

string

required

The ID of the buyer or seller to verify access

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Response Fields

data

object

The unique transaction ID

required

reference

The transaction reference number

required

type

The transaction type: anytime_escrow, timed_escrow, super_disbursement

required

sub_type

The transaction sub-type: super_disbursement, marketplace

required

status

The transaction status

required

funding_status

The funding status

required

amount

Net settlement amount in dollars (the create response instead uses a Money object in cents).

required

fee

The escrow fee in dollars

required

amount_with_fee

Total amount including fee

required

release_at

Auto-release date for timed escrow (null for anytime)

required

funding_details

Bank details for EFT/PayID funding

required

rail

Pinned funding rail: azupay or monoova

required

account_scope

Account scope: transaction for Azupay or party for Monoova

required

payment_reference

Reference to include with the payment. BECS may truncate lodgement references; a unique prefix of at least 12 hexadecimal UUID characters is accepted.

required

reference_required

Whether the payment reference is required for automatic allocation

required

provisioning_status

Funding account readiness: ready or pending

required

amount_received

Active amount received as a major-unit decimal string

required

amount_outstanding

Outstanding amount as a major-unit decimal string

required

Example request:

curl --request GET \
    --get "https://partners.staging.goescrow.net/api/v1/transactions/1?party_id=9d2e5c8a-1234-5678-9abc-def012345678" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "reference": "TXN-2024-001234",
        "type": "anytime_escrow",
        "sub_type": "marketplace",
        "status": "accepted",
        "funding_status": "pending",
        "amount": 150000.5,
        "fee": 1500,
        "amount_with_fee": 151500.5,
        "details": "Property settlement",
        "release_at": null,
        "created_at": "2024-01-15T10:30:00Z",
        "buyer_id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "buyer_reference": "ABC123",
        "seller_id": "9d2e5c8a-1234-5678-9abc-def012345679",
        "seller_reference": "XYZ789",
        "other_party_hint": "J*** D***",
        "funding_details": {
            "bsb": "123456",
            "account_number": "12345678",
            "account_name": "GoEscrow Trust",
            "pay_id": "pay@goescrow.com.au",
            "reference": "TXN-2024-001234",
            "rail": "azupay",
            "account_scope": "transaction",
            "payment_reference": "TXN-2024-001234",
            "reference_required": false,
            "provisioning_status": "ready",
            "amount_received": "0.00",
            "amount_outstanding": "151500.50"
        }
    }
}

Request beneficiary confirmation

POST

https://partners.staging.goescrow.net

/api/v1/transactions/{transaction_id}/beneficiaries/{beneficiary_id}/confirmation-request

requires authentication

Creates or rotates a single-use beneficiary confirmation link and sends it by SMS to the beneficiary. The token and confirmation URL are not returned to the partner.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

transaction

string

required

The transaction UUID

Example:

beneficiary

string

required

The beneficiary UUID

Example:

Body Parameters

heading

string

Optional plain-text confirmation page heading (maximum 60 characters).

Example:

Confirm your session

Response Fields

data

object

message

string

required

A safe acknowledgement that the confirmation link was sent.

Example:

Confirmation link sent

beneficiary_id

string

required

The UUID of the beneficiary receiving the confirmation request.

Example:

9d2e5c8a-1234-5678-9abc-def012345678

sent_to

string

required

The masked mobile number to which the confirmation SMS was sent.

Example:

+614****5678

expires_at

string

required

The confirmation link expiry time as an ISO 8601 timestamp.

Example:

2026-08-16T12:00:00+00:00

heading

string

required

The heading displayed on the beneficiary confirmation page.

Example:

Confirm receipt

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/transactions/1/beneficiaries/1/confirmation-request" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"heading\": \"Confirm your session\"
}"

Example response:

{
    "data": {
        "message": "Confirmation link sent",
        "beneficiary_id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "sent_to": "+614****5678",
        "expires_at": "2026-08-16T12:00:00+00:00",
        "heading": "Confirm receipt"
    }
}

Get transaction quote

POST

https://partners.staging.goescrow.net

/api/v1/transactions/quote

requires authentication

Calculates fees and provides a quote for a transaction without creating it. Uses the same request structure as transaction creation. This allows partners to show pricing to their customers before committing to a transaction.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

action

string

required

Transaction direction: buy or sell

Example:

buy

type

string

required

Transaction type: anytime_escrow or timed_escrow

Example:

anytime_escrow

amount_type

string

required

Indicates whether amount is escrow (gross) or settlement (net).

Example:

escrow

other_user

string

Counterparty user ID. Exactly one of other_user or other_company_id is required when disbursements are omitted.

Example:

9d2e5c8a-1234-5678-9abc-def012345678

other_company_id

string

Counterparty company ID. The company must be accessible to the partner and eligible to transact.

Example:

9d2e5c8a-1234-5678-9abc-def012345678

sub_type

string

The transaction sub type (optional: omit or null for plain anytime escrow)

Example:

super_disbursement

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

company_id

string

Source legal-party company ID. user_id must represent it. For super_disbursement this is required and must match the authenticated partner associated company.

Example:

9d2e5c8a-1234-5678-9abc-def012345678

release_at

string

Auto-release date for timed escrow in ISO 8601 format. Required when type is timed_escrow.

Example:

2024-12-31T23:59:59Z

details

string

required

Transaction details and description

Example:

Dental Surgery

amount

integer

required

Total transaction amount in cents (e.g., 15000050 for $150,000.50)

Example:

15000050

disbursements

string[]

Array of disbursement objects (required for super_disbursement). Omit for standard escrow to allocate automatically to other_user or other_company_id.

object

Response Fields

data

object

sub_type

Transaction sub type (null|super_disbursement|marketplace)

required

amount

Gross amount in dollars

required

partner_fee

Partner fee in dollars

required

partner_fee_percentage

Partner fee percentage applied

required

goescrow_fee

GoEscrow fee in dollars

required

goescrow_fee_percentage

GoEscrow fee percentage applied

required

total_fees

Total fees in dollars

required

net_amount

Net amount after fees in dollars

required

disbursements_count

Count of disbursements

required

disbursements

Array of disbursements (exactly one of user_id/company_id, plus amount) if provided

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/transactions/quote" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"action\": \"buy\",
    \"type\": \"anytime_escrow\",
    \"amount_type\": \"escrow\",
    \"other_user\": \"9d2e5c8a-1234-5678-9abc-def012345678\",
    \"other_company_id\": \"9d2e5c8a-1234-5678-9abc-def012345678\",
    \"sub_type\": \"super_disbursement\",
    \"user_id\": \"9d2e5c8a-1234-5678-9abc-def012345678\",
    \"company_id\": \"9d2e5c8a-1234-5678-9abc-def012345678\",
    \"release_at\": \"2024-12-31T23:59:59Z\",
    \"details\": \"Dental Surgery\",
    \"amount\": 15000050,
    \"disbursements\": [
        \"adipisci\"
    ]
}"

Example response:

{
    "data": {
        "sub_type": "super_disbursement",
        "amount": 150000.5,
        "partner_fee": 299.4,
        "partner_fee_percentage": 0.2,
        "goescrow_fee": 0,
        "goescrow_fee_percentage": 0,
        "total_fees": 299.4,
        "net_amount": 149701.1,
        "disbursements_count": 2,
        "disbursements": [
            {
                "user_id": "9d2e5c8a-1234-5678-9abc-def012345679",
                "amount": 74850.55
            },
            {
                "company_id": "9d2e5c8a-1234-5678-9abc-def012345680",
                "amount": 74850.55
            }
        ]
    }
}

Upload transaction files

POST

https://partners.staging.goescrow.net

/api/v1/transactions/{transaction_id}/files

requires authentication

Uploads one or more files to a transaction filing cabinet. The authenticated partner must own the transaction or be its marketplace operator.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

transaction_id

string

required

The transaction UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

files

file[]

required

One or more files to upload.

Example:

Response Fields

data

object

The transaction file ID

required

file

The private storage path

required

filename

The original uploaded filename

required

created_at

The upload timestamp

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/transactions/9d2e5c8a-1234-5678-9abc-def012345678/files" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "files[]=@/tmp/php1o66eobt7j4l2IaBanK"

Example response:

{
    "data": [
        {
            "id": "9d2e5c8a-1234-5678-9abc-def012345678",
            "file": "a1b2c3d4/document.pdf",
            "filename": "document.pdf",
            "created_at": "2024-01-15T10:30:00Z"
        }
    ]
}

Trigger marketplace settlement

POST

https://partners.staging.goescrow.net

/api/v1/transactions/{transaction_id}/settle

requires authentication

Triggers settlement for a marketplace escrow transaction. Only the marketplace operator can trigger settlement.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Idempotency-Key

Example:

6f3a8e1c-9b2d-4f5a-8c1e-2a7b9d0e1f23

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

transaction_id

string

required

The transaction UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

buyer_id

string

required

The buyer legal-party user or company ID for verification

Example:

9d2e5c8a-1234-5678-9abc-def012345678

seller_id

string

required

The seller legal-party or disbursement-recipient user or company ID for verification

Example:

9d2e5c8a-1234-5678-9abc-def012345679

settlement_amount

number

required

The settlement amount (must match escrow amount)

Example:

150000.5

Response Fields

message

Success message

required

transaction_id

The transaction ID

required

status

The new transaction status

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/transactions/9d2e5c8a-1234-5678-9abc-def012345678/settle" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Idempotency-Key: 6f3a8e1c-9b2d-4f5a-8c1e-2a7b9d0e1f23" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"buyer_id\": \"9d2e5c8a-1234-5678-9abc-def012345678\",
    \"seller_id\": \"9d2e5c8a-1234-5678-9abc-def012345679\",
    \"settlement_amount\": 150000.5
}"

Example response:

{
    "message": "Settlement initiated successfully.",
    "transaction_id": "9d2e5c8a-1234-5678-9abc-def012345678",
    "status": "settlement_in_progress"
}

Transaction PayTo Payment

Initiate PayTo Payments for Transactions

Initiate PayTo payment

POST

https://partners.staging.goescrow.net

/api/v1/transactions/{transaction_id}/payto-payment

requires authentication

Initiates a PayTo debit payment from the specified user's bank account to fund the transaction. The user must have an active PayTo agreement. This endpoint dispatches an async job and returns immediately with a tracking ID.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Idempotency-Key

Example:

6f3a8e1c-9b2d-4f5a-8c1e-2a7b9d0e1f23

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

transaction_id

string

required

The transaction UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

user_id

string

required

The ID of the user initiating the payment (must have active PayTo agreement)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Response Fields

code

Result code: accepted, transaction_already_funded, no_payment_agreement, transaction_not_payable

required

message

Human-readable message

required

tracking_id

Unique tracking ID to poll for payment status

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/transactions/9d2e5c8a-1234-5678-9abc-def012345678/payto-payment" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Idempotency-Key: 6f3a8e1c-9b2d-4f5a-8c1e-2a7b9d0e1f23" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": \"9d2e5c8a-1234-5678-9abc-def012345678\"
}"

Example response:

{
    "code": "accepted",
    "message": "Payment initiation queued. Use the tracking_id to poll for status.",
    "tracking_id": "payto_9d2e5c8a"
}

Check PayTo payment status

GET

https://partners.staging.goescrow.net

/api/v1/transactions/{transaction_id}/payto-payment/{id}

requires authentication

Checks the status of a PayTo payment using either a tracking_id (from async initiation) or a payment_initiation_id (from Azupay).

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

transaction_id

string

required

The transaction UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

string

required

Either a tracking_id (e.g., payto_abc123) or an Azupay payment_initiation_id (e.g., PI-123456789)

Example:

payto_abc123

Response Fields

code

Result code: queued, processing, initiated, pending, settled, failed, timeout, error

required

message

Human-readable message

required

status

Current payment status

required

payment_initiation_id

The Azupay payment initiation ID (if available)

required

Example request:

curl --request GET \
    --get "https://partners.staging.goescrow.net/api/v1/transactions/9d2e5c8a-1234-5678-9abc-def012345678/payto-payment/payto_abc123" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "code": "settled",
    "message": "Payment settled successfully. Transaction is now funded.",
    "status": "settled"
}

User Bank Account Management

Manage User Bank Accounts

Update user bank account

PUT

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/bank-account

requires authentication

Updates the bank account details for a user. This will automatically trigger a verification payout of $0.01 to the new account with a 6-digit verification code in the transaction description.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

bsb_number

string

required

The BSB number (6 digits)

Example:

123456

account_number

string

required

The bank account number

Example:

12345678

account_name

string

required

The account holder name

Example:

John Doe

Response Fields

message

Success message

required

is_verified

Whether the bank account is verified (will be false after update)

required

Example request:

curl --request PUT \
    "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/bank-account" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"bsb_number\": \"123456\",
    \"account_number\": \"12345678\",
    \"account_name\": \"John Doe\"
}"

Example response:

{
    "message": "Bank account updated. Verification code sent via $0.01 payout.",
    "is_verified": false
}

Verify user bank account

POST

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/bank-account/verify

requires authentication

Verifies the bank account using the 6-digit code received in the $0.01 verification payout.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

code

string

required

The 6-digit verification code from the bank transaction

Example:

123456

Response Fields

message

Success or error message

required

is_verified

Whether the bank account is now verified

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/bank-account/verify" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"123456\"
}"

Example response:

{
    "message": "Bank account verified successfully.",
    "is_verified": true
}

User Identification Management

Manage User Identification Documents

Create or update user passport

POST

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/passport

requires authentication

Creates a new passport record for the user or updates an existing one. Only one passport per user is allowed.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

document_number

string

required

Passport document number

Example:

N1234567

first_name

string

required

First name as shown on passport

Example:

John

last_name

string

required

Last name as shown on passport

Example:

Doe

middle_name

string

Middle name as shown on passport

Example:

Michael

issuing_country

string

Country that issued the passport, as shown on the document. Required unless nationality is provided.

Example:

United Kingdom

nationality

string

Deprecated: kept for backwards compatibility; use issuing_country. Required unless issuing_country is provided.

Example:

British

date_of_birth

string

required

Date of birth in YYYY-MM-DD format

Example:

1990-01-15

date_of_issue

string

required

Date of issue in YYYY-MM-DD format

Example:

2020-01-15

date_of_expiration

string

required

Date of expiration in YYYY-MM-DD format

Example:

2030-01-15

place_of_birth

string

required

Place of birth as shown on passport

Example:

Sydney, Australia

gender

string

Gender as shown on passport (M, F, X, or BLANK)

Example:

Response Fields

data

object

The unique identifier of the passport record

required

document_number

The passport document number

required

rapidid_verification_requested_at

Timestamp when RapidID verification was requested

required

rapidid_verified_at

Timestamp when RapidID verification was completed successfully

required

rapidid_failed_at

Timestamp when RapidID verification failed

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/passport" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"document_number\": \"N1234567\",
    \"first_name\": \"John\",
    \"last_name\": \"Doe\",
    \"middle_name\": \"Michael\",
    \"issuing_country\": \"United Kingdom\",
    \"nationality\": \"British\",
    \"date_of_birth\": \"1990-01-15\",
    \"date_of_issue\": \"2020-01-15\",
    \"date_of_expiration\": \"2030-01-15\",
    \"place_of_birth\": \"Sydney, Australia\",
    \"gender\": \"M\"
}"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "document_number": "N1234567",
        "first_name": "John",
        "last_name": "Doe",
        "middle_name": "Michael",
        "nationality": "United Kingdom",
        "issuing_country": "United Kingdom",
        "date_of_birth": "1990-01-15",
        "date_of_issue": "2020-01-15",
        "date_of_expiration": "2030-01-15",
        "place_of_birth": "Sydney, Australia",
        "gender": "M",
        "rapidid_verification_requested_at": null,
        "rapidid_verified_at": null,
        "rapidid_failed_at": null,
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
    }
}

Get user passport

GET

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/passport

requires authentication

Retrieves the passport information for the specified user.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Example request:

curl --request GET \
    --get "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/passport" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "document_number": "N1234567",
        "first_name": "John",
        "last_name": "Doe",
        "middle_name": "Michael",
        "nationality": "United Kingdom",
        "issuing_country": "United Kingdom",
        "date_of_birth": "1990-01-15",
        "date_of_issue": "2020-01-15",
        "date_of_expiration": "2030-01-15",
        "place_of_birth": "Sydney, Australia",
        "gender": "M",
        "rapidid_verification_requested_at": null,
        "rapidid_verified_at": null,
        "rapidid_failed_at": null,
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
    }
}

Delete user passport

DELETE

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/passport

requires authentication

Deletes the passport record for the specified user.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Example request:

curl --request DELETE \
    "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/passport" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Create or update user Medicare card

POST

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/medicare

requires authentication

Creates a new Medicare card record for the user or updates an existing one. Only one Medicare card per user is allowed.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

document_number

string

required

Medicare card number (10 digits)

Example:

1234567890

name_on_card

string

Name as shown on Medicare card

Example:

John Michael Doe

card_color

string

required

Medicare card color (green, blue, or yellow)

Example:

green

individual_reference_number

string

required

Individual reference number (1 digit)

Example:

expiration_date

string

required

Expiration date in YYYY-MM format

Example:

2025-12

Response Fields

data

object

The unique identifier of the Medicare card record

required

document_number

The Medicare card number

required

card_color

The Medicare card color

required

rapidid_verification_requested_at

Timestamp when RapidID verification was requested

required

rapidid_verified_at

Timestamp when RapidID verification was completed successfully

required

rapidid_failed_at

Timestamp when RapidID verification failed

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/medicare" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"document_number\": \"1234567890\",
    \"name_on_card\": \"John Michael Doe\",
    \"card_color\": \"green\",
    \"individual_reference_number\": \"1\",
    \"expiration_date\": \"2025-12\"
}"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "document_number": "1234567890",
        "name_on_card": "John Michael Doe",
        "card_color": "green",
        "individual_reference_number": "1",
        "expiration_date": "2025-12",
        "rapidid_verification_requested_at": null,
        "rapidid_verified_at": null,
        "rapidid_failed_at": null,
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
    }
}

Get user Medicare card

GET

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/medicare

requires authentication

Retrieves the Medicare card information for the specified user.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Example request:

curl --request GET \
    --get "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/medicare" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "document_number": "1234567890",
        "name_on_card": "John Michael Doe",
        "card_color": "green",
        "individual_reference_number": "1",
        "expiration_date": "2025-12",
        "rapidid_verification_requested_at": null,
        "rapidid_verified_at": null,
        "rapidid_failed_at": null,
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
    }
}

Delete user Medicare card

DELETE

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/medicare

requires authentication

Deletes the Medicare card record for the specified user.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Example request:

curl --request DELETE \
    "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/medicare" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Create or update user driver license

POST

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/driver-license

requires authentication

Creates a new driver license record for the user or updates an existing one. Only one driver license per user is allowed.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

state_issued

string

required

State or territory that issued the license (NSW, VIC, QLD, SA, WA, TAS, NT, ACT)

Example:

NSW

license_number

string

required

Driver license number

Example:

12345678

card_number

string

required

Driver license card number

Example:

1234567890

expiration_date

string

required

Expiration date in YYYY-MM-DD format

Example:

2030-01-15

first_name

string

required

First name as shown on license

Example:

John

last_name

string

required

Last name as shown on license

Example:

Doe

middle_name

string

Middle name as shown on license

Example:

Michael

date_of_birth

string

required

Date of birth in YYYY-MM-DD format

Example:

1990-01-15

Response Fields

data

object

The unique identifier of the driver license record

required

state_issued

The state or territory that issued the license

required

license_number

The driver license number

required

rapidid_verification_requested_at

Timestamp when RapidID verification was requested

required

rapidid_verified_at

Timestamp when RapidID verification was completed successfully

required

rapidid_failed_at

Timestamp when RapidID verification failed

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/driver-license" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"state_issued\": \"NSW\",
    \"license_number\": \"12345678\",
    \"card_number\": \"1234567890\",
    \"expiration_date\": \"2030-01-15\",
    \"first_name\": \"John\",
    \"last_name\": \"Doe\",
    \"middle_name\": \"Michael\",
    \"date_of_birth\": \"1990-01-15\"
}"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "state_issued": "NSW",
        "license_number": "12345678",
        "card_number": "1234567890",
        "expiration_date": "2030-01-15",
        "first_name": "John",
        "last_name": "Doe",
        "middle_name": "Michael",
        "date_of_birth": "1990-01-15",
        "rapidid_verification_requested_at": null,
        "rapidid_verified_at": null,
        "rapidid_failed_at": null,
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
    }
}

Get user driver license

GET

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/driver-license

requires authentication

Retrieves the driver license information for the specified user.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Example request:

curl --request GET \
    --get "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/driver-license" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "state_issued": "NSW",
        "license_number": "12345678",
        "card_number": "1234567890",
        "expiration_date": "2030-01-15",
        "first_name": "John",
        "last_name": "Doe",
        "middle_name": "Michael",
        "date_of_birth": "1990-01-15",
        "rapidid_verification_requested_at": null,
        "rapidid_verified_at": null,
        "rapidid_failed_at": null,
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
    }
}

Delete user driver license

DELETE

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/driver-license

requires authentication

Deletes the driver license record for the specified user.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Example request:

curl --request DELETE \
    "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/driver-license" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Create or update user immigration card

POST

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/immigration-card

requires authentication

Creates a new immigration card record for the user or updates an existing one. Only one immigration card per user is allowed.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

given_name

string

required

Given name as shown on the card

Example:

John

family_name

string

required

Family name as shown on the card

Example:

Doe

card_number

string

required

Immigration card number

Example:

IMM123456

expiration_date

string

required

Card expiration date (YYYY-MM-DD)

Example:

2030-01-15

card_type

string

required

Type of immigration card (ams, eis, pre, rdi)

Example:

ams

vevo_check_given_name

string

DEPRECATED. Never fed a VEVO check and is no longer read; still accepted and stored for backwards compatibility.

Example:

John

vevo_check_family_name

string

DEPRECATED. Never fed a VEVO check and is no longer read; still accepted and stored for backwards compatibility.

Example:

Doe

vevo_check_passport_number

string

DEPRECATED. Not part of the ImmiCard document check; still accepted and stored for backwards compatibility.

Example:

N1234567

vevo_check_country_of_issue

string

DEPRECATED. Not part of the ImmiCard document check; still accepted and stored for backwards compatibility.

Example:

Australia

Response Fields

data

object

The unique identifier of the immigration card record

required

card_number

The immigration card number

required

card_type

Type of immigration card

required

rapidid_verification_requested_at

Timestamp when RapidID verification was requested

required

rapidid_verified_at

Timestamp when RapidID verification was completed successfully

required

rapidid_failed_at

Timestamp when RapidID verification failed

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/immigration-card" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"given_name\": \"John\",
    \"family_name\": \"Doe\",
    \"card_number\": \"IMM123456\",
    \"expiration_date\": \"2030-01-15\",
    \"card_type\": \"ams\",
    \"vevo_check_given_name\": \"John\",
    \"vevo_check_family_name\": \"Doe\",
    \"vevo_check_passport_number\": \"N1234567\",
    \"vevo_check_country_of_issue\": \"Australia\"
}"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "given_name": "John",
        "family_name": "Doe",
        "card_number": "IMM123456",
        "expiration_date": "2030-01-15",
        "card_type": "ams",
        "vevo_check_given_name": "John",
        "vevo_check_family_name": "Doe",
        "vevo_check_passport_number": "N1234567",
        "vevo_check_country_of_issue": "Australia",
        "rapidid_verification_requested_at": null,
        "rapidid_verified_at": null,
        "rapidid_failed_at": null,
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
    }
}

Get user immigration card

GET

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/immigration-card

requires authentication

Retrieves the immigration card information for the specified user.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Example request:

curl --request GET \
    --get "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/immigration-card" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "given_name": "John",
        "family_name": "Doe",
        "card_number": "IMM123456",
        "expiration_date": "2030-01-15",
        "card_type": "ams",
        "vevo_check_given_name": "John",
        "vevo_check_family_name": "Doe",
        "vevo_check_passport_number": "N1234567",
        "vevo_check_country_of_issue": "Australia",
        "rapidid_verification_requested_at": null,
        "rapidid_verified_at": null,
        "rapidid_failed_at": null,
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
    }
}

Delete user immigration card

DELETE

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/immigration-card

requires authentication

Deletes the immigration card record for the specified user.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Example request:

curl --request DELETE \
    "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/immigration-card" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Create or update user Centrelink card

POST

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/centrelink-card

requires authentication

Creates a new Centrelink card record for the user or updates an existing one. Only one Centrelink card per user is allowed.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

crn

string

required

Customer Reference Number (9 digits + letter)

Example:

123456789A

name_on_card

string

required

Name as shown on the card

Example:

John Doe

expiration_date

string

required

Card expiration date (YYYY-MM-DD)

Example:

2030-01-15

card_type

string

required

Type of Centrelink card (hcc, pcc, shc)

Example:

hcc

Response Fields

data

object

The unique identifier of the Centrelink card record

required

crn

The Customer Reference Number

required

card_type

Type of Centrelink card

required

rapidid_verification_requested_at

Timestamp when RapidID verification was requested

required

rapidid_verified_at

Timestamp when RapidID verification was completed successfully

required

rapidid_failed_at

Timestamp when RapidID verification failed

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/centrelink-card" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"crn\": \"123456789A\",
    \"name_on_card\": \"John Doe\",
    \"expiration_date\": \"2030-01-15\",
    \"card_type\": \"hcc\"
}"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "crn": "123456789A",
        "name_on_card": "John Doe",
        "expiration_date": "2030-01-15",
        "card_type": "hcc",
        "rapidid_verification_requested_at": null,
        "rapidid_verified_at": null,
        "rapidid_failed_at": null,
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
    }
}

Get user Centrelink card

GET

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/centrelink-card

requires authentication

Retrieves the Centrelink card information for the specified user.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Example request:

curl --request GET \
    --get "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/centrelink-card" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "crn": "123456789A",
        "name_on_card": "John Doe",
        "expiration_date": "2030-01-15",
        "card_type": "hcc",
        "rapidid_verification_requested_at": null,
        "rapidid_verified_at": null,
        "rapidid_failed_at": null,
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
    }
}

Delete user Centrelink card

DELETE

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/centrelink-card

requires authentication

Deletes the Centrelink card record for the specified user.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Example request:

curl --request DELETE \
    "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/centrelink-card" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

User PayTo Agreement Management

Manage User PayTo Agreements

Get PayTo agreement status

GET

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/payto-agreement

requires authentication

Returns the current PayTo agreement status and details for a user.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Response Fields

has_agreement

Whether the user has a PayTo agreement

required

agreement_id

The PayTo agreement ID (null if no agreement)

required

maximum_amount

The maximum amount allowed per transaction (null if no agreement)

required

status

The agreement status: ACTIVE, CREATED, SUSPENDED, CANCELLED, FAILED (null if no agreement)

required

Example request:

curl --request GET \
    --get "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/payto-agreement" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "has_agreement": true,
    "agreement_id": "PA-123456",
    "maximum_amount": 10000,
    "status": "ACTIVE"
}

Create PayTo agreement

POST

https://partners.staging.goescrow.net

/api/v1/users/{user_id}/payto-agreement

requires authentication

Creates a new PayTo agreement for the user. The user must authorize the agreement in their banking app.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

string

required

The user UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

maximum_amount

number

required

The maximum amount per transaction (max 10,000)

Example:

5000

pay_id

string

The PayID (email, phone, ABN, or ORG ID). Either pay_id or bank account details required.

Example:

john@example.com

pay_id_type

string

The PayID type: PHONE, EMAIL, ABN, or ORG

Example:

account_name

string

Bank account holder name (required if using bank account)

Example:

John Doe

account_number

string

Bank account number (required if using bank account)

Example:

12345678

bsb

string

Bank BSB number (required if using bank account)

Example:

123456

Response Fields

agreement_id

The new PayTo agreement ID

required

status

The initial agreement status (CREATED - awaiting user authorization)

required

message

Instructions for next steps

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/users/9d2e5c8a-1234-5678-9abc-def012345678/payto-agreement" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"maximum_amount\": 5000,
    \"pay_id\": \"john@example.com\",
    \"pay_id_type\": \"EMAIL\",
    \"account_name\": \"John Doe\",
    \"account_number\": \"12345678\",
    \"bsb\": \"123456\"
}"

Example response:

{
    "agreement_id": "PA-123456",
    "status": "CREATED",
    "message": "PayTo agreement created. User must authorize in their banking app."
}

Webhook Management

Manage webhook subscriptions for transaction events

List webhooks

GET

https://partners.staging.goescrow.net

/api/v1/webhooks

requires authentication

Returns all registered webhooks for the authenticated partner.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Response Fields

data

Array of webhook objects

required

object

The webhook ID

required

url

The webhook URL

required

events

Array of subscribed events (null = all events)

required

is_active

Whether the webhook is active

required

failure_count

Number of consecutive delivery failures

required

Example request:

curl --request GET \
    --get "https://partners.staging.goescrow.net/api/v1/webhooks" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": "9d2e5c8a-1234-5678-9abc-def012345678",
            "url": "https://partner.com/webhooks/goescrow",
            "events": [
                "transaction.created",
                "transaction.clearance_pending",
                "transaction.funded",
                "transaction.status_changed",
                "transaction.funding_status_changed"
            ],
            "is_active": true,
            "last_triggered_at": "2024-01-15T10:30:00Z",
            "failure_count": 0,
            "created_at": "2024-01-01T00:00:00Z"
        }
    ]
}

Register webhook

POST

https://partners.staging.goescrow.net

/api/v1/webhooks

requires authentication

Registers a new webhook URL to receive transaction event notifications. Available events: transaction.created (when a transaction is created), transaction.clearance_pending (when inbound funding is held for clearance), transaction.funded (when a transaction is funded), transaction.status_changed (when transaction status changes), transaction.funding_status_changed (when transaction funding status changes), transaction.completed (when a transaction is completed/settled), beneficiary.confirmation_requested (when beneficiary confirmation is requested), beneficiary.confirmed (when a beneficiary confirms receipt), beneficiary.declined (when a beneficiary reports non-receipt).

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

url

string

required

The webhook URL (must be HTTPS)

Example:

https://partner.com/webhooks/goescrow

events

string[]

Array of events to subscribe to. Available events: transaction.created, transaction.clearance_pending, transaction.funded, transaction.status_changed, transaction.funding_status_changed, transaction.completed, beneficiary.confirmation_requested, beneficiary.confirmed, beneficiary.declined. Omit or pass null to receive all events.

Example:

["transaction.created","beneficiary.confirmation_requested","beneficiary.confirmed","beneficiary.declined"]

Response Fields

message

Success message

required

The webhook ID

required

url

The registered webhook URL

required

secret

The signing secret for HMAC verification. Store this securely - it is only shown once.

required

events

Array of subscribed events

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/webhooks" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"https:\\/\\/partner.com\\/webhooks\\/goescrow\",
    \"events\": [
        \"transaction.created\",
        \"beneficiary.confirmation_requested\",
        \"beneficiary.confirmed\",
        \"beneficiary.declined\"
    ]
}"

Example response:

{
    "message": "Webhook registered successfully.",
    "id": "9d2e5c8a-1234-5678-9abc-def012345678",
    "url": "https://partner.com/webhooks/goescrow",
    "secret": "whsec_abc123xyz789...",
    "events": [
        "transaction.created",
        "transaction.clearance_pending"
    ]
}

Delete webhook

DELETE

https://partners.staging.goescrow.net

/api/v1/webhooks/{id}

requires authentication

Unregisters a webhook.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

webhook

string

required

The webhook ID

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Response Fields

message

Success message

required

Example request:

curl --request DELETE \
    "https://partners.staging.goescrow.net/api/v1/webhooks/1" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "message": "Webhook deleted successfully."
}

List webhook deliveries

GET

https://partners.staging.goescrow.net

/api/v1/webhooks/{webhook_id}/deliveries

requires authentication

Returns the delivery history for a webhook (most recent first), so missed events can be inspected and replayed after an outage. Each delivery records the event, the exact payload that was (or will be) sent, the number of attempts, and the last response status.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

webhook

string

required

The webhook ID

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Response Fields

data

Array of delivery objects (most recent first)

required

object

The delivery ID (matches the "id" field in the webhook payload envelope)

required

event

The event that was delivered

required

status

Delivery status: pending, delivered, failed, or skipped

required

attempts

Number of delivery attempts made

required

response_status

HTTP status code of the last response (null if never reached)

required

payload

The data payload that was sent for this event

required

Example request:

curl --request GET \
    --get "https://partners.staging.goescrow.net/api/v1/webhooks/1/deliveries" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": "9f1b2c3d-4567-89ab-cdef-0123456789ab",
            "event": "transaction.funded",
            "status": "failed",
            "attempts": 3,
            "response_status": 500,
            "last_attempted_at": "2024-01-15T10:32:00Z",
            "delivered_at": null,
            "created_at": "2024-01-15T10:30:00Z",
            "payload": {
                "transaction_id": "...",
                "status": "pending"
            }
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 50,
        "total": 1
    }
}

Redeliver a webhook event

POST

https://partners.staging.goescrow.net

/api/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliver

requires authentication

Queues a fresh delivery attempt for a past event, using the original payload. Use this to backfill events your endpoint missed during an outage. A new delivery record is created (with a new id) so the original attempt history is preserved.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

webhook

string

required

The webhook ID

Example:

9d2e5c8a-1234-5678-9abc-def012345678

delivery

string

required

The delivery ID to redeliver

Example:

9f1b2c3d-4567-89ab-cdef-0123456789ab

Response Fields

The ID of the new delivery created for this redelivery

required

event

The event being redelivered

required

status

Status of the new delivery (pending)

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/webhooks/1/deliveries/1/redeliver" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "message": "Webhook delivery has been queued for redelivery.",
    "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "event": "transaction.funded",
    "status": "pending"
}

Company Bank Account Management

Manage company bank accounts using Confirmation of Payee

Update company bank account

PUT

https://partners.staging.goescrow.net

/api/v1/companies/{company_id}/bank-account

requires authentication

Updates company bank details and runs Confirmation of Payee checks against the company's active known names.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

company_id

string

required

The company UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

bsb_number

string

required

The BSB number (6 digits)

Example:

123456

account_number

string

required

The bank account number

Example:

12345678

account_name

string

required

The submitted account holder name

Example:

Acme Corp Pty Ltd

Response Fields

message

Success message

required

is_verified

Whether Confirmation of Payee has verified the bank account

required

Example request:

curl --request PUT \
    "https://partners.staging.goescrow.net/api/v1/companies/9d2e5c8a-1234-5678-9abc-def012345678/bank-account" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"bsb_number\": \"123456\",
    \"account_number\": \"12345678\",
    \"account_name\": \"Acme Corp Pty Ltd\"
}"

Example response:

{
    "message": "Company bank account updated successfully.",
    "is_verified": true
}

Re-check company bank account

POST

https://partners.staging.goescrow.net

/api/v1/companies/{company_id}/bank-account/verify

requires authentication

Re-runs Confirmation of Payee against the company's existing bank details. This is not payout-code verification.

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

company_id

string

required

The company UUID (36-character internal identifier)

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Response Fields

message

Success message

required

is_verified

Whether Confirmation of Payee has verified the bank account

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/companies/9d2e5c8a-1234-5678-9abc-def012345678/bank-account/verify" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "message": "Company bank account check completed.",
    "is_verified": true
}

Create an identity-only hosted login session, send the user to the returned GoEscrow URL, receive a one-time code at the registered redirect URL, then verify the code server-to-server. The redirect URL is configured by GoEscrow and snapshotted when the session is created.

POST

https://partners.staging.goescrow.net

/api/v1/login-sessions

requires authentication

Creates a short-lived hosted login session. Open the returned url in the user's browser. After the user signs in and confirms, GoEscrow redirects to the partner's registered URL with session_id, code, and the optional reference query parameters.

curl -X POST 'https://partner-api.goescrow.com.au/api/v1/login-sessions' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"email":"jane@example.com","reference":"order-8812"}'

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

Optional email address used only to prefill the hosted login form. It does not constrain the identity that can sign in.

Example:

jane@example.com

reference

string

Optional partner correlation identifier, echoed in the redirect and verification response.

Example:

order-8812

Response Fields

data

object

The hosted login session UUID

required

url

The single-use GoEscrow-hosted URL to open in the user browser

required

expires_at

The hosted URL expiry as an ISO 8601 timestamp

required

reference

The optional partner correlation identifier

required

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/login-sessions" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"jane@example.com\",
    \"reference\": \"order-8812\"
}"

Example response:

{
    "data": {
        "id": "9d2e5c8a-1234-5678-9abc-def012345678",
        "url": "https://app.goescrow.com.au/partner-login/plaintext-session-token",
        "expires_at": "2026-08-31T04:15:00.000000Z",
        "reference": "order-8812"
    }
}

POST

https://partners.staging.goescrow.net

/api/v1/login-sessions/{loginSession}/verify

requires authentication

Redeems the one-time code delivered to the registered redirect URL. Verification must use the same partner API key that created the session and must occur before the code expires.

curl -X POST 'https://partner-api.goescrow.com.au/api/v1/login-sessions/9d2e5c8a-1234-5678-9abc-def012345678/verify' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"code":"CODE_FROM_REDIRECT"}'

Headers

X-API-Key

Example:

{YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

loginSession

string

required

The hosted login session UUID returned during creation.

Example:

9d2e5c8a-1234-5678-9abc-def012345678

Body Parameters

code

string

required

The one-time code received at the registered redirect URL.

Example:

CODE_FROM_REDIRECT

Response Fields

data

object

Example request:

curl --request POST \
    "https://partners.staging.goescrow.net/api/v1/login-sessions/9d2e5c8a-1234-5678-9abc-def012345678/verify" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"CODE_FROM_REDIRECT\"
}"

Example response:

{
    "data": {
        "user": {
            "id": "9d2e5c8a-1234-5678-9abc-def012345678",
            "reference": "ABC123",
            "first_name": "Jane",
            "last_name": "Doe",
            "email": "jane@example.com",
            "phone": "+61412345678",
            "birth_date": "1990-01-15",
            "kyc_verified": true,
            "aml_verified": true,
            "aml_verified_at": "2026-08-20T00:00:00.000000Z",
            "email_verified": true,
            "mobile_verified": true,
            "mobilekyc_verified": true,
            "bank_verified": true,
            "suspended": false,
            "address": null
        },
        "reference": "order-8812",
        "authenticated_at": "2026-08-31T04:01:00.000000Z"
    }
}