Quick Start

Step 1: Obtain your API keys and your endpoint url#

To use the service, you need an endpoint url and an API key to add to the request headers.

To get your API key, please send a request to techsupport@bankify.io.

Step 2: Create a code and password#

Create a domain for your data in the system by entering a new usercode, password and an organization name, and a url for receiving notification messages for your users.

The usercode must be at least 8 characters long and the password must be alphanumeric and at least 7 characters long.

curl --location --request POST 'https://staging.financialgoals.microservice.bankify.io/api/v1/organizations/' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <yourapikeyhere>' \
--data-raw '{
    "code": "testorganization",
    "name": "Test Organization",
    "password": "SuperSecretPassw0rd",
    "endpoint": "https://thisiswherewesend.notification.info.for.your.users:port/and/path"
}'

Successful response:

{"name":"Test Organization","code":"testorganization","endpoint": "https://thisiswherewesend.notification.info.for.your.users:port/and/path"}

Step 3: Log in#

curl --location --request POST 'https://staging.financialgoals.microservice.bankify.io/auth/v1/authenticate/' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <yourapikeyhere>' \
--data-raw '{
    "code": "testorganization",
    "password": "SuperSecretPassw0rd"
}'

Successful response:

{"token":"eyJhbGciOiJIUzI1...."}

Please note the token your received in the response, as this token is needed in all the subsequent requests.

Step 4: Check that you are logged in#

Make a request to any of the methods requiring logging in. Add the token you received in the previous step to the Authorization header.

curl --location --request GET 'https://staging.financialgoals.microservice.bankify.io/api/v1/organizations/current' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <yourapikeyhere>' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1....' 

Successful response:

{"name":"Test Organization","code":"testorganization","endpoint": "https://thisiswherewesend.notification.info.for.your.users:port/and/path"}

That's it!#

Now you can use any endpoints described in the Swagger documentation. You can also use our Postman collection.

The workflow after logging in is creating users, creating goals for users and then creating transactions towards the goals.