Webhooks

POST

yourURLhere/webhook/{requestId}

Path Parameters

requestIdstringrequired
Example
b5ea0d25-0fc4-4e2a-ab85-23ba29510126

Responses

200

Notification
Description
Can be EntityStatusChange, UpdateEntityState, or BusinessOwnershipQuery
- objectCompany
  - entityApplicantIdstring
    Example
    e2d91eb9-7922-f111-8341-7ced8da15ab5
  - statusstring
    Example
    PASS
  - messagestring
    Example
    Profile status is now 'Passed'
  - entityTypestring
    Example
    ORGANISATION
  - companyNamestring
    Example
    OZ AIRCONDITIONING PTY LTD
  - registrationNumberstring
    Example
    74157843626
  - externalReferencestring
    Example
    customer-ref-12345
- objectIndividual
  - individualApplicantIdstring
    Example
    2887a52a-4516-b0b1-0cb0-5f9533bd82ff
  - statusstring
    Example
    PASS
  - messagestring
    Example
    Profile status is now 'Passed'
  - entityTypestring
    Example
    INDIVIDUAL
  - nameFirststring
    Example
    John
  - nameMiddlestring
    Example
    Corp
  - nameLaststring
    Example
    Doe
  - addressobject
    - countrystring
      Example
      AUS
    - postalCodestring
      Example
      2200
    - statestring
      Example
      NSW
    - streetNamestring
    - streetNumberstring
    - streetTypestring
    - townstring
      Example
      Bankstown
    - unitNumberstring
  - externalReferencestring
    Example
    customer-ref-12345

curl

curl --request POST \
     --url yourURLhere/webhook/{requestId} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("yourURLhere/webhook/{requestId}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("yourURLhere/webhook/{requestId}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "yourURLhere/webhook/{requestId}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

{}