A login hint to suggest a user to use for 'enduring_access' requests. This will be ignored for other request types. The user may choose to authenticate as a different Akahu user than specified. This may be in the form of an email address or an Akahu User ID.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/akahu/main/json-schema/akahu-enduring-login-hint-schema.json",
"title": "EnduringLoginHint",
"description": "A login hint to suggest a user to use for 'enduring_access' requests. This will be ignored for other request types.\nThe user may choose to authenticate as a different Akahu user than specified.\nThis may be in the form of an email address or an Akahu User ID.",
"x-generated": "2026-10-26",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/akahu-auth-api-openapi.yml#/components/schemas/EnduringLoginHint",
"anyOf": [
{
"$ref": "#/$defs/EmailAddress"
},
{
"$ref": "#/$defs/UserId"
}
],
"$defs": {
"EmailAddress": {
"type": "string",
"format": "email"
},
"UserId": {
"type": "string",
"pattern": "^user_[a-z0-9]{25,27}$"
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.