System Resource Names
API Input Body Headers and Error Types
System Resource Name (SRN)
System Resource Name is a typed identifier that may reference any object within the alfred ecosystem. Many of our API calls and data schemas leverage SRNs in order to add flexibility and decouple services. All SRNs follow the same URI-like format:
type:identifier
Some common types you are likely to encounter from our API below:
Type | Description |
---|---|
| Your API Key for authentication e.g.: |
| Your API Secret for enhanced security e.g.: |
| Access token obtained from KYC Lite e.g.: |
| Type of transaction e.g. |
| Balance of user's wallet, if type is “in” (onramp) then balance is 0, when the type is “out” (offramp) you must set the balance crypto currency e.g. |
| crypto currency withdraw or Deposit (BTC, USDT, USDC) e.g. |
| An alfred user, user's wallet, username, email or phone number e.g. |
| Blockchain can be stellar, ethereum, bitcoin LN, or Network Banking number e.g. |
| Unique Transaction number issues e.g. |
| A cellphone number e.g. |
| An email address e.g. |
| User's first name e.g. |
| User's Last name e.g. |
| User's full name e.g. |
| Address of user e.g. |
| City of residence e.g. |
| Country of residence e.g. |
| Country where withdrawal will take place //ISO Format, it also can be to use to deposit. e.g. |
| Zip code of User or Bank e.g. |
| User's date of birth e.g. |
| ID number of an individual user e.g. |
| Name of the bank e.g. |
| Number given to specify an individual bank e.g. |
| The owner is obtained by token user, if the value is different, it will take the full name token e.g. |
| Specific code to specify the country e.g. |
| Amount being withdrawn e.g. |
| A cellphone number e.g. |
| Can be found in uid - myinfo e.g. |
| Business ID number e.g. |
| Identification for an exchange e.g. |
| Type of Institution processing transaction e.g. |
| Based on the desired action either status can appear e.g. |
| Specific Invoice Hash e.g. |
| value docType can be either: e.g. |
Last updated