Customer

This page includes all the endpoints for the Customer endpoints.

[ Base URL: customers:8080/ ]

https://apicb.test.aazzur.com/docs/services/customers

customers-controller

The createCustomer request creates the customer for the application. The whole process of creating a customer is already mentioned on the Authentication Workflow page.

createCustomer

POST//customers:8080/v1/customers

Header parameters

Body

application/json

body

addressAddress

bundlesarray of string

consentsarray of Consent

email*string

employeeStatusstring

kycsarray of Kyc

languagestring

monthlyIncomestring

passportInfoPassportInfo

password*string

phoneNumberstring

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/customers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text",
      "password": "text"
    }),
});
const data = await response.json();

The getBundles request sends the active bundles to the registered customer. For the request to work, you must send the oauth token as the Bearer token as the authentication process.

getBundles

GET//customers:8080/v1/customers/active-bundles

Response

200401403404

OK

Body

application/json

bundlesarray of ProgrammeBundle

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/customers/active-bundles', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "bundles": [
    {
      "bundleDisplayName": "text",
      "bundleId": "text",
      "bundleName": "text",
      "bundles": [
        "text"
      ],
      "createdBy": "text",
      "featureConfigurations": [
        {
          "configuration": "SHARE_ACCOUNT",
          "value": "ENABLED"
        }
      ],
      "limitConfigurations": [
        {
          "configuration": "NEW_ACCOUNT_ACCOUNT_LIMIT"
        }
      ],
      "updatedBy": "text"
    }
  ]
}

The getCurrentCustomer request sends the customer information that is associated with the token that is sent with the request. A sample successful response is added after the request.

getCurrentCustomer

Required scopes - signup

GET//customers:8080/v1/customers/me

Response

200401403404

OK

Body

application/json

addressAddress

applicationStateenum

INITIATEDPENDINGACCEPTEDREJECTED

bundlesarray of string

consentsConsents

customerStateenum

INITIATEDENROLLMENT_STARTEDENROLLEDREJECTEDPENDING

dateOfBirthstring (date)

emailstring

firstNamestring

genderenum

MALEFEMALEOTHER

idstring

languagestring

lastNamestring

nationalitystring

numberOfTokensinteger (int64)

phoneNumberstring

programmestring

shippingAddressAddress

titlestring

unsatisfiedRequirementsarray of enum

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/customers/me', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "address": {
    "details": {
      "city": "text",
      "country": "text",
      "firstLine": "text",
      "postCode": "text",
      "state": "text"
    }
  },
  "applicationState": "INITIATED",
  "bundles": [
    "text"
  ],
  "consents": {
    "cardTermsAndConditions": false,
    "newsletter": false,
    "privacyPolicy": false,
    "productUpdates": false,
    "termsAndConditions": false
  },
  "customerState": "INITIATED",
  "dateOfBirth": "2024-05-07",
  "email": "text",
  "firstName": "text",
  "gender": "MALE",
  "id": "text",
  "language": "text",
  "lastName": "text",
  "nationality": "text",
  "phoneNumber": "text",
  "programme": "text",
  "shippingAddress": {
    "details": {
      "city": "text",
      "country": "text",
      "firstLine": "text",
      "postCode": "text",
      "state": "text"
    }
  },
  "title": "text",
  "unsatisfiedRequirements": [
    "PERSONAL_INFO"
  ]
}

{
    "id": "123123123",
    "email": "[e-mail]",
    "phoneNumber": "[phone]",
    "firstName": "John",
    "lastName": "Doe",
    "dateOfBirth": "1900-01-01",
    "language": "en-US",
    "address": {
        "addressLine1": "100",
        "city": "CITY",
        "country": "US",
        "postalCode": "1234"
    },
    "shippingAddress": {
        "addressLine1": "100",
        "city": "CITY",
        "country": "US",
        "postalCode": "1234"
    },
    "nationality": "US",
    "numberOfTokens": 500,
    "applicationState": "ACCEPTED",
    "unsatisfiedRequirements": [],
    "title": "Mr",
    "gender": "MALE",
    "consents": {
        "privacyPolicy": true,
        "termsAndConditions": true
    },
    "programme": "AAZZUR",
    "bundles": [
        "123-123-123"
    ]
}

The updateCustomer request is used to update any data of the customer that is associated with the token. For example, if you want to change the address or maybe the title of the customer or add extra information such as the shipping address, you will have to use this request to update the existing customer's information.

updateCustomer

Required scopes - signup

PATCH//customers:8080/v1/customers/me

Body

application/json

body

addressAddress

consentsarray of Consent

languagestring

passportInfoPassportInfo

phoneNumberstring

shippingAddressAddress

Response

202204401403

Accepted

Body

*/*

statusstring

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/customers/me', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "status": "text"
}

The getUserBundles request sends the Feature Configuration and Limit Configuration data. The Feature Configuration Object has the data for the features like if the Split Bill feature is enabled or not. On the other hand, the Limit Configuration object has the data for the physical card limit number, virtual card limit number, etc.

getUserBundles

GET//customers:8080/v1/customers/me/bundle-configuration

Response

200401403404

OK

Body

application/json

featureConfigurationsarray of BundleFeatureConfiguration

limitConfigurationsarray of BundleLimitConfiguration

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/customers/me/bundle-configuration', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "featureConfigurations": [
    {
      "configuration": "SHARE_ACCOUNT",
      "value": "ENABLED"
    }
  ],
  "limitConfigurations": [
    {
      "configuration": "NEW_ACCOUNT_ACCOUNT_LIMIT"
    }
  ]
}

updateBundles

PATCH//customers:8080/v1/customers/me/bundle-details

Body

application/json

body

bundleIdsarray of string

Response

200204401403

OK

Body

application/json

statusstring

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/customers/me/bundle-details', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "status": "text"
}

To verify the user email, the requestEmailVerification request comes in. The request does not require the email address but the oauth token only. After a successful request, the user will get an email to confirm the email.

requestEmailVerification

Required scopes - signup

POST//customers:8080/v1/customers/me/email-verification-request

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/customers/me/email-verification-request', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

updateNotificationToken

Required scopes - signup

POST//customers:8080/v1/customers/me/notification-tokens

Body

application/json

body

tokenstring

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/customers/me/notification-tokens', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

If you want to change the user's password then you will have to use the changePassword request. The request requires a body with the new and the old password.

changePassword

Required scopes - user

POST//customers:8080/v1/customers/me/password

Body

application/json

body

newPassword*string

oldPassword*string

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/customers/me/password', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "newPassword": "text",
      "oldPassword": "text"
    }),
});
const data = await response.json();

sendVerificationToken

Required scopes - signup

POST//customers:8080/v1/customers/me/phone-verification-request

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/customers/me/phone-verification-request', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Users require PIN to do some tasks like transfering money or check card details, etc. Using the changePin request, you can change the User PIN, keeping in mind that the password is required to change the PIN for the user.

changePin

Required scopes - signup

POST//customers:8080/v1/customers/me/pin

Body

application/json

body

passwordstring

pin*string

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/customers/me/pin', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "pin": "text"
    }),
});
const data = await response.json();

device-controller

registerDevice

Required scopes - signup

POST//customers:8080/v1/devices

Body

application/json

request

code*integer (int32)

deviceNamestring

publicKey*string

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/devices', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "publicKey": "text"
    }),
});
const data = await response.json();

unbindDevice

Required scopes - devices Required scopes - devices Enhanced security through pin, password or challenge - as applicable - required, based on jurisdiction and/or client configuration

DELETE//customers:8080/v1/devices/{id}

Path parameters

id*string

id

Response

202204401403

Accepted

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/devices/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

image-controller

You will have to use the addImage POST request to upload images on the server. The request will need the image in the body of the request. After a successful POST request, the response will contain the image id by which you can make a GET request getImage to get the image. A sample response for this request is added below the POST request.

addImage

POST//customers:8080/v1/images

Query parameters

Body

image/pngimage/jpeg

image

string (byte)

Response

200201401403404

OK

Body

application/json

uristring

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/images', {
    method: 'POST',
    headers: {
      "Content-Type": "image/png"
    },
    body: JSON.stringify("Ynl0ZXM="),
});
const data = await response.json();

Response

{
  "uri": "text"
}

{
    "uri": "v1/images/123123123a-123-123123-123123-123123123"
}

When you want to get an image that you have uploaded to the server already, just use the image id from the previous request's response. From the previous POST request's response, the id should be the one after the images/ for example 123123123a-123-123123-123123-123123123

getImage

GET//customers:8080/v1/images/{id}

Path parameters

id*string

id

Response

200401403404

OK

Body

image/pngimage/jpeg

string (byte)

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/images/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"Ynl0ZXM="

onboarding-controller

onboarding

Required scopes - signup

GET//customers:8080/v1/customers/me/onboarding

Response

200401403404

OK

Body

application/json

statusstring

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/customers/me/onboarding', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "status": "text"
}

onboarding

Required scopes - signup

POST//customers:8080/v1/customers/me/onboarding

Query parameters

Response

200201401403404

OK

Body

application/json

statusstring

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/customers/me/onboarding', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "status": "text"
}

password-recovery-controller

The initiate request starts the flow of password recovery. After you have sent a request with the email in the body, you will get a response object that has the status object "OK". If the entered email is not found within the system, the status will be "NOT_FOUND".

If the status is "OK", you will get an email containing information to reset your account password.

initiate

POST//customers:8080/v1/password-recovery

Header parameters

Body

application/json

body

email*string

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/password-recovery', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text"
    }),
});
const data = await response.json();

After initiating the password recovery flow, you will have to check if the user can reset the password. To get the questions or the reset status, use the getChallenges request. A sample response body is shown for understanding.

You will have to click on the reset password button link on the same device that you are logged in to.

getChallenges

GET//customers:8080/v1/password-recovery/{id}

Path parameters

id*string

id

Response

200202401403404

OK

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/password-recovery/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
    "questions": [
        {
            "id": "SAMPLE ID 1",
            "securityQuestion": "BIRTH_DATE"
        },
        {
            "id": "SAMPLE ID 2",
            "securityQuestion": "ADDRESS_CITY"
        }
    ],
    "resetAllowed": false
}

The above sample response has two questions and these two separate questions have different ids. To solve challenges, you will have to use the below request with the password recovery id and the challengeid. For example the request body to solve the first question should be like this:

{
    "solution": "1900-01-01"
}

If the solution is correct then you will get a 200 response status with an "OK" value.

If you send another request to the getChallenges, you will see that the first question is not there anymore because it is solved. After solving two of the challenges, the request questions array will be empty, and the value of resetAllowed will be true. A sample response is added after the request for your convenience.

solveChallenge

POST//customers:8080/v1/password-recovery/{id}/challenges/{challengeId}

Path parameters

challengeId*string

challengeId

id*string

id

Body

application/json

body

solution*string

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/password-recovery/{id}/challenges/{challengeId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "solution": "text"
    }),
});
const data = await response.json();

{
    "questions": [],
    "resetAllowed": true
}

After knowing that you are allowed to reset the password from the previous request, go ahead and request for the password reset using the below request. You will have to put the id for the password request in the path and in the body, put the new password in the password JSON.

resetPassword

POST//customers:8080/v1/password-recovery/{id}/password-change-request

Path parameters

id*string

id

Body

application/json

body

password*string

Response

201202401403404

Created

Request

JavaScriptCurl

const response = await fetch('//customers:8080/v1/password-recovery/{id}/password-change-request', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "password": "text"
    }),
});
const data = await response.json();