API docs by Redocly

ajor API (0.1.0)

Download OpenAPI specification:

Thrift savings backend. Every response uses the same envelope.

auth

Registration, verification and login

Start a signup and send a verification code

Request Body schema: application/json
required
firstName
required
string [ 2 .. 32 ] characters
lastName
required
string [ 2 .. 32 ] characters
email
required
string <email> <= 254 characters
phone
required
string^\+(?:234|44)[0-9]{10}$

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "user@example.com",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "statusCode": 0,
  • "message": "string",
  • "data": null
}

Verify a phone number with the code that was sent

Request Body schema: application/json
required
phone
required
string^\+(?:234|44)[0-9]{10}$
code
required
string = 6 characters ^[0-9]+$

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "statusCode": 0,
  • "message": "string",
  • "data": {
    }
}

Send a fresh verification code

Request Body schema: application/json
required
phone
required
string^\+(?:234|44)[0-9]{10}$

Responses

Request samples

Content type
application/json
{
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "statusCode": 0,
  • "message": "string",
  • "data": null
}

Set the password and finish signup

Request Body schema: application/json
required
password
required
string [ 8 .. 48 ] characters
confirmPassword
required
string
setupToken
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "stringst",
  • "confirmPassword": "string",
  • "setupToken": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "statusCode": 0,
  • "message": "string",
  • "data": {
    }
}

Log in

Request Body schema: application/json
required
required
string or string
password
required
string <= 48 characters

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "statusCode": 0,
  • "message": "string",
  • "data": {
    }
}

Exchange a refresh token for a new pair

Request Body schema: application/json
required
refreshToken
required
string [ 40 .. 200 ] characters

Responses

Request samples

Content type
application/json
{
  • "refreshToken": "stringstringstringstringstringstringstri"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "statusCode": 0,
  • "message": "string",
  • "data": {
    }
}