resolve

This endpoint is used to resolve an alias to a display name. It is possible for this endpoint to return a 503 service unavailable error if the addressing service is not available.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
Allowed:
string
required

A PayID phone alias. e.g. +61-411222333

requester
object
required

Details of the end-user requesting this resolution.

sandbox
object

SANDBOX ONLY: Parameter that allows you to simulate certain alias lookup scenarios to aid integrators while testing their control flows.

Headers
string
Defaults to 20250101

API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.

Responses

403

forbidden

404

not found

500

Internal Server Error

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json