Aliases

Title Fetch Alias

Retrieve account title metadata for a Raast alias. An alias such as a mobile number can reveal an account holder's name, so restrict this operation to an authenticated, transaction-bound backend flow and apply your own abuse-prevention limits.

get/v1/aggregators/{raast-aggregator-id}/title-fetch/alias

Request

  • Base URL: https://api.getsafepay.com/raastwire
  • URL: https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/title-fetch/alias
  • Auth: API key in header X-SFPY-AGGREGATOR-SECRET-KEY

Query parameters

typestring
Example:TILL_CODE

Alias type used for lookup; only TILL_CODE is supported currently.

valueinteger
Example:541732040

Alias value to resolve; must be provided when alias_type is supplied.

with_title_fetchboolean
Example:true

When true, include account title details in the response.

Response

This response contains account title details fetched from Raast for an alias

api_versionstring

The current version of the API spec

Example response

{
  "api_version": "v1"
}

Changes

No recorded changes to this operation across all 1 revision of this API.