Skip to main content
POST
Shortcode Lookup

Authorizations

Authorization
string
header
required

JWT Bearer token for authentication. Example: "Bearer YOUR_API_TOKEN_HERE"

Body

application/json

Shortcode to resolve (4 letters + 4 digits)

Shortcode to resolve (4 letters + 4 digits)

shortcode
string

The shortcode to look up (4 letters followed by 4 digits, e.g. ABCD1234)

Example:

"RBAA2112"

Response

OK

data
object

Response payload

error
string

Error message (only present when ok is false)

Example:

""

ok
boolean

Whether the request was successful

Example:

true