1. Deactivate account

This endpoint deactivates a user account, preventing the user from accessing the system or performing any actions that require authentication.

Takes bearer token to get the authenticated user and deactivates it.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as customer to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

Authorization*:

string

No payload

application/json

{
    "msg": "Account deactivate request submitted!"
}

2. Register

This endpoint registers a new user account in the system. This typically involves providing basic information such as username, email, and password.

Takes user data specified in request body and registers user.

Endpoint

application/json

email*:

string

username*:

string

name:

string

user_type:

string enum:[ CUSTOMER, BANK_ADMIN, FINTRACT_ADMIN, DEVELOPER, DEVELOPER_ADMIN ]

password*:

string

password2*:

string

phone*:

string

customer_id:

string

gender:

string enum:[MALE,FEMALE,]

application/json

id:

integer

email*:

string

username*:

string

name:

string

user_type:

string enum:[ CUSTOMER, BANK_ADMIN, FINTRACT_ADMIN, DEVELOPER, DEVELOPER_ADMIN ]

password*:

string

password2*:

string

phone*:

string

customer_id:

string

gender:

string enum:[MALE,FEMALE,]

application/json

{
    "username": "JohnDoe0303",
    "email": "johndoe@gmail.com",
    "name": "John",
    "user_type": "DEVELOPER",
    "phone": "1234567890",
    "gender": "MALE",
    "password": "johnDoe@#",
    "password2": "johnDoe@#"
}

application/json

{
    "id": 78,
    "username": "JohnDoe0303",
    "email": "johndoe@gmail.com",
    "name": "John",
    "user_type": "DEVELOPER",
    "phone": "1234567890",
    "customer_id": "7001808879932062",
    "gender": "MALE"
}

3. Login

This endpoint allows a user to log in to the system using their credentials (e.g., username and password).

Takes email & password and sends otp to email/phone number.

Endpoint

application/json

email*:

string

otpType*:

string enum:[Email, Phone]

userType:

string enum:[ CUSTOMER, BANK_ADMIN, FINTRACT_ADMIN, DEVELOPER, DEVELOPER_ADMIN ]

password*:

string

application/json

data:

object

id:

integer

application/json

{
    "email": "johndoe@gmail.com",
    "otpType":"Email",
    "userType":"Developer",
    "password": "johnDoe@#"
}

application/json

{
    "data": {
        "id": 93
    }
}

4. Verify OTP

This endpoint facilitates user authentication by verifying the OTP provided after login for a specific user identified by the id parameter.

Upon receiving the OTP the admin approves the OTP to determine its authenticity and validity.

Endpoint

id*:

string

application/json

otp*:

string

application/json

message:

string

id:

integer

customer_id:

string

email*:

string

username*:

string

verification_status:

boolean

tokens:

object

refresh:

<refresh token>

access:

<access token>

user_type:

string enum:[ CUSTOMER, BANK_ADMIN, FINTRACT_ADMIN, DEVELOPER, DEVELOPER_ADMIN ]

application/json

{
    "otp": "123456"
}

application/json

{
    "message": "Successfully Logged In",
    "id": 93,
    "customer_id": "7001808879932062",
    "email": "johndoe@gmail.com",
    "username": "JohnDoe0303",
    "verification_status": true,
    "tokens": {
        "refresh": "kjdbgkjsbgkgyftfghfkyfkukguyg",
        "access": "jhkgjgkjvhgfuftfjhguytguygkjgh"
    },
    "user_type": "DEVELOPER"
}

5. Admin Approval

This endpoint facilitates the approval process for granting access to customer accounts by administrators.

This endpoint can only be accessed by users with administrative privileges (e.g., FINTRACT_ADMIN). Users without sufficient permissions will receive this error response.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as FINTRACT_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

Authorization*:

string

application/json

customer_id*:

string

application/json

msg:

string

application/json

{
    "customer_id": "34712234559419273"
}

application/json

{
    "msg": "User admin approved"
}

6. Upload User Avatar

Allows a user to upload or update their avatar image. The id parameter specifies the user whose avatar is being updated.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to specifically login as CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

id*:

string

Authorization*:

string

multipart/form-data

file*:

file

application/json

user:

object

multipart/form-data

{
    file: "profile.png"
}

application/json

{
    "user": {
        "id": 93,
        "password": "hdbkjhhgfhtgmhkjgukyfm",
        "last_login": null,
        "is_superuser": false,
        "user_type": "CUSTOMER",
        "gender": "FEMALE",
        "username": "Johndoe34",
        "email": "",
        "phone": "",
        "avatar": "https://openbankingapp.s3.amazonaws.com/b906a186.jpg",
        "customer_id": "865565869898",
        "name": "John Doe",
        "country": "USA",
        "citizenship": "",
        "national_id": "",
        "address": "",
        "is_staff": false,
        "is_active": true,
        "is_deactivate": false,
        "is_verified": true,
        "admin_approved": true,
        "bank": "",
        "otp": "0",
        "groups": [],
        "user_permissions": []
    }
}

7. Delete User

Deletes a user account from the system permanently. This action is irreversible and removes all associated user data.

Takes bearer access token and deletes the account.

Endpoint

Authorization*:

string

application/json

msg:

string

No payload

application/json

{
    "msg": "Account Successfully deleted"
}

8. Resend Verification Mail

Initiates the process to re-verify a user's email address. This is typically used when an email address needs to be re-confirmed for security reasons.

Takes email and resends verification mail with token.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to login as CUSTOMER or BANK_ADMIN to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

application/json

email*:

string

application/json

message:

string

application/json

{
    "email": "johndoe@gmail.com"
}

application/json

{
    "message": "New token sent"
}

9. Get User Info

Retrieves detailed information about a specific user account identified by the id parameter.

Takes user id and returns user email, phone & other details.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to login as CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

id*:

string

Authorization*:

string

application/json

id:

integer

email:

string

avatar:

string

username:

string

name:

string

net_balance:

integer

verification_status:

boolean

phone:

string

customer-id:

string

country:

string

citizenship:

string

national_id:

string

address:

string

bank_name:

string

gender:

string enum:[MALE,FEMALE,]

No payload

application/json

{
    "id": 93,
    "email": "email": "johndoe@gmail.com",
    "avatar": "",
    "gender": "MALE",
    "username": "JohnDoe0303",
    "name": "John",
    "net balance": 0,
    "customer-id": "2160658639884",
    "verification_status": true,
    "phone": "1234567890",
    "country": "",
    "citizenship": "",
    "national_id": "",
    "address": "",
    "bank_name": ""
}

10. Update User Info

Updates user information for the user identified by the id parameter. This allows for updating specific fields without requiring all user information to be provided.

Takes user data and updates citizenship, national_id, name and others.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to login as CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

id*:

string

Authorization*:

string

application/json

email:

string

username:

string

name:

string

phone:

string

country:

string

citizenship:

string

national_id:

string

address:

string

application/json

message:

string

application/json

{
    "username": "JohnDoe123",
    "email": "",
    "name": "",
    "phone": "",
    "country": "USA",
    "citizenship": "",
    "national_id": "",
    "address": ""
}

application/json

{
    "message": "Updated Successfully"
}

11. Update Username & name

Updates user name and name only for the user identified by the access token

Takes only username & name and updates them.

Refer to the Authentication Guide for details on obtaining and using API keys. You need to login as CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

Authorization*:

string

application/json

username*:

string

name*:

string

application/json

message:

string

application/json

{
    "username": "Johndoe109",
    "name": "John B Doe"
}

application/json

{
    "msg": "Account Successfully Updated"
}

12. Upload file

This endpoint takes file and uploads it & returns file url

Refer to the Authentication Guide for details on obtaining and using API keys. You need to login as CUSTOMER to access this API. When you make calls to the tokenization API, include the API key as bearer access token in the authorization header.

Endpoint

Authorization*:

string

multipart/form-data

file*:

file

application/json

url:

string

multipart/form-data

passport.pdf

application/json

{
    "url": "https://openbankingapp.s3.amazonaws.com/c3510aee.csv"
}