curl --request GET \
--url "https://directory.example.com/aliases/river.stone"
{
"alias": "river.stone",
"did": "did:openpayload:1111111111111111111111"
}
DIDs
Resolve an alias
Look up the OpenPayload DID currently associated with a public alias
curl --request GET \
--url "https://directory.example.com/aliases/river.stone"
{
"alias": "river.stone",
"did": "did:openpayload:1111111111111111111111"
}
An alias is a short, human-friendly public name that points to an OpenPayload DID. Use this endpoint when a person gives your application an alias instead of a complete
did:openpayload:... identifier.
Alias lookup is read-only and requires no signature.
Before you use an alias
Aliases improve usability, but the DID remains the cryptographic identity. Resolve the returned DID before selecting keys or sending a message. The Directory normalizes aliases to lowercase. Valid aliases use letters, digits,_, ., and -, with a maximum length of 64 characters. They cannot contain @ or #, which are reserved for delivery-target and DID-document syntax.
Request
string
required
The complete public alias. URL-encode it if it contains characters that are not safe in a URL path.
curl --request GET \
--url "https://directory.example.com/aliases/river.stone"
Response
string
required
The normalized alias that was resolved.
string
required
The OpenPayload DID that currently owns the alias.
{
"alias": "river.stone",
"did": "did:openpayload:1111111111111111111111"
}
Next step
Resolve the returned DID:curl --request GET \
--url "https://directory.example.com/resolve/did%3Aopenpayload%3A1111111111111111111111"
Straight to the point
GET /aliases/{url-encoded-alias}
- Authentication: none
- Body: none
- Success:
200 - Unknown alias:
404