Skip to main content
Check out our new content, navigation and design for digital service providers.

COVID-19 - Level 2 If you have been affected by COVID-19, we may be able to help. Find out more

Gateway services are available over the internet with endpoints documented for each individual web service.

JSON API communication standards

Aspect Standard/protocol Version
Transport protocol HTTPS HTTP 1.1
Transport layer encryption TLS 1.2
Access tokens OAuth or client signed JWT 2.0

Development versions of JSON APIs are provided with YAML (Open API) documentation.

SOAP web services communication standards

Aspect Standard/protocol Version
Message envelope SOAP 1.2
Service contracts WSDL 1.1
Operation identification WS-Addressing 1.0
Transport protocol HTTPS HTTP 1.1
Transport layer encryption TLS 1.2
Access tokens OAuth 2.0

Development versions of WSDL contracts and schemas are provided with service documentation. Those hosted with the web service are too generic to allow test or code generation.

All message requests made to us must include both:

  • a SOAP header
  • the WS-Addressing 1.0 action element identifying the operation namespace (shown in sample requests).