API Overview

Prerequisites:

API requires below common data:

• Bearer Token get from Get a Bearer Token – Equaze Help Documentation.
• API Key get from Regenerate API Key – Equaze Help Documentation or Get Existing API Key – Equaze Help Documentation.

Once Bearer Token and API Key are retrieved, User can use following common APIs:

A. Get User’s Account general information:

1. Follow this guide to get your AccountERN of your Account Get Information of User’s Account – Equaze Help Documentation.
2. Save the AccountERN for later use.

B. APIs related to Beneficiary:

1. Add New Beneficiary by following this guide Adding New Beneficiary to Account – Equaze Help Documentation
   This request requires:
   1. AccountERN that you want to create beneficiary to.
   2. Bearer Token of current User.
2. Lookup Beneficiary by following this guide: Account Beneficiary Lookup – Equaze Help Documentation
   This request requires:
   1. AccountERN that you want to create beneficiary to.
   2. Bearer Token of current User.
3. Delete Beneficiary by following this guide: Deleting a Beneficiary – Equaze Help Documentation
   This request requires:
   1. AccountERN that you want to delete beneficiary linked to.
   2. BeneficiaryId of the Beneficiary linked to the AccountERN.

C. Send Funds API

This request requires:

1. API Key retrieved from Regenerate API Key – Equaze Help Documentation or Get Existing API Key – Equaze Help Documentation
2. The Nickname of beneficiary retrieved from Account Beneficiary Lookup – Equaze Help Documentation
3. Digital Signature generated from The “Digital Signature” Creation Using .NET (Dotnet) – Equaze Help Documentation
4. Certificate Thumbprint generated from Generate a Digital Certificate in Online account – Equaze Help Documentation
5. Prepare the Request Body: Create a Valid Body for the Digital Certificate in Postman – Equaze Help Documentation
6. Proceed to make Send Funds request:  Initiating a Secure PKI Transaction Using API – Equaze Help Documentation