Quickstart on AcuCheck API

Overview

This guide provides details about the AcuCheck APIs and related information, which is helpful to developers, solution architects, and integration teams who want to embed financial analysis and customer verification features into their applications. The AcuCheck API offers RESTful endpoints that allow you to authenticate securely, manage customer profiles, initiate instant bank analysis, and generate comprehensive financial reports. By using these APIs, you can streamline customer onboarding, calculate debt-to-income ratios, analyze banking transactions, and assess financial risk with speed and accuracy.

API Information

All API requests are made over HTTPS. The AcuCheck API is exposed under the title:

AcuCheck.Api

  • Protocol: HTTPS

  • Content Type: application/json

Headers

Some endpoints require additional custom headers.

  • Header key name:X-Timezone

  • Header value: IANA time zone identifier (e.g., "America/Los_Angeles")

Authentication Endpoints:AcuCheck uses token-based authentication to secure API access. Users authenticate via the login endpoint to receive a session token, which must then be included in subsequent requests. Sessions can be terminated using the logout endpoint, and the current session status can be validated at any time.
Endpoint Method Purpose Auth Required Request Body Success Response 
/api/v1/auth/login
 POST Authenticate a user and establish a session No 

{ 
"email": 
"string",
"password": 
"string" 
}
 200 OK → 

{ 

  "success": true, 

  "message": "Login successful", 

  "data": { 

	" accessToken”: “eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30”, 

    	"refreshToken": "b4f71786-bf1e-43a7-8de7-b87e2f924caa" 

  }, 

  "errors": null 

} 
/api/v1/auth/logout
 POST Terminate the current user session Yes 

{
 "refreshToken": 
 "string" 
}
 200 OK → 

{ 
"success": true,
 "message": "Logout successful." 
}
 
/api/v1/auth/status
 GET Retrieve status of the current authenticated user Yes None 200 OK → 
{ 
 	"success": true, 
	 "message": "Status fetched successfully.", 
	 "data": { 

}, 
	 "errors": null 
}

1. Authenticate

To securely log in and obtain a token that allows you to access other AcuCheck services.

Request Parameters

The following are the request parameters for POST /api/v1/auth/login:
Field Data Type Required Description 
email
 string Yes The user’s login email. 
password
 string Yes The user’s account password.

Request


{ 

  "email": "user@example.com", 

  "password": "SecurePassword123!" 

}

Response Parameters

The following are the response parameters for POST /api/v1/auth/login:
Field Data Type Description 
success
 boolean Indicates whether the login request was successful. 
message
 string A short description of the login outcome. 
data
 object Contains the authentication tokens issued after successful login. 
data.accessToken
 string (JWT) The access token to be used for authenticating subsequent API requests. 
data.refreshToken
 string A refresh token used to obtain a new access token when the current one expires. 
errors
 object | null Provides details if any errors occurred during login. Returns null when the request is successful.

Response


{ 

  "success": true, 

  "message": "Login successful", 

  "data": { 

	" accessToken”: “eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30”, 

    	"refreshToken": "b4f71786-bf1e-43a7-8de7-b87e2f924caa" 

  }, 

  "errors": null 

}

2. Check Current User Status

You can check the login status and view details of the currently authenticated user.

Request Parameters

The following are the request parameters for GET /api/v1/auth/status:
Field Data Type Required Description Example
email string Yes The user’s login email. "user@example.com"
password string Yes The user’s account password. "SecurePassword123!"

Request: None

Response Parameters

The following are the response parameters for POST /api/v1/auth/login:
Field Data Type Description 
success
 boolean Indicates whether the login request was successful. 
message
 string A short description of the login outcome. 
data
 object Contains the authentication tokens issued after successful login. 
data.accessToken
 string (JWT) The access token to be used for authenticating subsequent API requests. 
data.refreshToken
 string A refresh token used to obtain a new access token when the current one expires. 
errors
 object | null Provides details if any errors occurred during login. Returns null when the request is successful.

Response


{ 
 	"success": true, 
	 "message": "Status fetched successfully.", 
	 "data": { 

}, 
	 "errors": null 
}

3. Add a New Customer

You can use this API to create a new customer record in the system.

Request Parameters

The following are the request parameters for POST /api/v1/customer:

Table 1. Headers
Field Data Type Required Description
Authorization string Yes Bearer token from login.
Content-Type string Yes Media type of the request body.
Table 2. Body
Field Data Type Required Description 
userName
 string Yes Login/handle for the customer 
companyName
 string No* Business name (see validation rules below) 
password
 string Yes Customer account password 
customerType
 number Yes 1 = customer, 2 = business (per rules) 
lastName
 string Yes Surname 
firstName
 string Yes Given name 
phoneType
 string No Type of phone 
phoneNumber
 string Yes Digits only, 10 digits 
email
 string Yes Email address 
addressLine1
 string Yes Address line 1 
country
 string Yes Country 
addressLine2
 string No Address line 2 
city
 string Yes City 
state
 string Yes State/Province 
postalCode
 string Yes Postal/ZIP code 
employer
 string No Employer (for customers) 
occupation
 string No Occupation 
monthlyIncome
 number No Monthly income (numeric) 
payFrequency
 string No Monthly, Bi-Monthly, Weekly, Bi-Weekly 
driversLicense
 string No Driver’s license number 
ssn
 string Yes 9 digits (no dashes) 
dob
 string Yes ISO-8601 datetime; must be in the past 
bankName
 string No Bank name 
bankAccNo
 string No Bank account number (≥ 6 digits) 
routingNo
 string No 9 digits 
ein
 string No* Business EIN (only for business type) 
employerName
 string No Employer legal name 
triggerReportRequest
 boolean No If true, also trigger a report request 
countryCode
 string No ISO country code

Request


{ 
	  "userName": "string", 
	  "companyName": "string", 
	  "password": "string", 
	  "customerType": 1, 
	  "lastName": "string", 
	  "firstName": "string", 
	  "phoneType": "string", 
	  "phoneNumber": "0735011867", 
	  "email": "user@example.com", 
	  "addressLine1": "string", 
	  "country": "string", 
	  "addressLine2": "string", 
	  "city": "string", 
	  "state": "string", 
	  "postalCode": "string", 
	  "employer": "string", 
	  "occupation": "string", 
	  "monthlyIncome": 0, 
	  "payFrequency": "string", 
	  "driversLicense": "string", 
	  "ssn": "string", 
	  "dob": "2025-08-14T15:39:46.487Z", 
	  "bankName": "string", 
	  "bankAccNo": "34366787628003539", 
	  "routingNo": "247250588", 
	  "ein": "string", 
	  "employerName": "string", 
	  "triggerReportRequest": true, 
	  "countryCode": "string" 
}

Response Parameters

The following are the respone parameters for POST /api/v1/customer:

200 OK
Table 3. Top-level fields:
Field Data Type Description 
success
 boolean Operation status 
message
 string Outcome message 
data
 object Created customer record 
errors
 null Null on success
Table 4. data object:
Field Data Type Description 
id
 string Customer identifier (GUID) 
userName
 string Customer username 
companyName
 string Business name 
password
 string Stored/hashed password (as returned) 
customerType
 number 1 = customer, 2 = business 
lastName
 string Surname 
firstName
 string Given name 
phoneType
 string Phone type 
phoneNumber
 string Phone number (digits) 
email
 string Email 
addressLine1
 string Address line 1 
country
 string Country 
addressLine2
 string Address line 2 
city
 string City 
state
 string State/Province 
postalCode
 string Postal/ZIP code 
employer
 string Employer 
occupation
 string Occupation 
monthlyIncome
 number Monthly income 
payFrequency
 string Payout frequency 
driversLicense
 string Driver’s license number 
ssn
 string SSN (as returned) 
dob
 string Birthdate (ISO-8601) 
bankName
 string Bank name 
bankAccNo
 string Bank account number 
routingNo
 string Routing number 
ein
 string EIN (for business) 
employerName
 string Employer legal name 
createdDate
 string Creation timestamp (ISO-8601)

Response


{ 
  "success": true, 
  "message": "Customer created successfully.", 
  "data": { 
    "id": "308ff8f2-bbd4-4794-acca-8a35b9382f9a", 
    "userName": "john_doe",	 
    "companyName": "Doe Enterprises", 
    "password": "EncryptedPassword123!", 
    "customerType": 2, 
    "lastName": "Doe", 
    "firstName": "John", 
    "phoneType": "Mobile", 
    "phoneNumber": "1555761234", 
    "email": "john.doe@example.com", 
    "addressLine1": "123 Main St", 
    "country": "USA", 
    "addressLine2": "Apt 4B", 
    "city": "Metropolis", 
    "state": "NY", 
    "postalCode": "10001", 
    "employer": "Tech Corp", 
    "occupation": "Software Developer", 
    "monthlyIncome": 7500, 
    "payFrequency": "Bi-Weekly", 
    "driversLicense": "D1234567", 
    "ssn": "123456789", 
    "dob": "1990-05-24T00:00:00.0000000Z", 
    "bankName": "First National Bank", 
    "bankAccNo": "1234567890", 
    "routingNo": "011000015", 
    "ein": "123456789", 
    "employerName": "Tech Corp Inc.", 
    "createdDate": "2024-08-14T15:26:21.4504709Z" 
  }, 
  "errors": null 
}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request forPOST /api/v1/customer:
Table 5. Top-level fields:
Field Data Type Description 
success
 boolean Always false for validation errors 
message
 string Error summary 
data
 null Always null 
errors
 array List of validation messages

400 Bad Request


{ 
  "success": false, 
  "message": "Validation failed for the request.", 
  "data": null, 
  "errors": [ 
    "Email is required.", 
    "Invalid email format.", 
    "First name is required.", 
    "Last name must not exceed 50 characters.", 
    "Phone number must be exactly 10 digits.", 
    "Password is required.", 
    "Postal code must not exceed 10 characters.", 
    "Date of Birth must be in the past.", 
    "SSN must be exactly 9 digits.", 
    "Bank Account Number must be at least 6 digits.", 
    "Routing number must be exactly 9 digits.", 
    "Bank name must not exceed 100 characters.", 
    "Address line 1 is required.", 
    "City must not exceed 50 characters.", 
    "State must not exceed 50 characters.", 
    "Country is required.", 
    "Customer type must be either 'customer' or 'business'.", 
    "Employer name must not exceed 100 characters.", 
    "Pay Frequency must be one of the following: Monthly, Bi-Monthly, Weekly, Bi-Weekly.", 
    "Company name should be empty for regular customers.", 
    "EIN should be empty for regular customers." 
  ] 
}

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error forPOST /api/v1/customer:
Table 6. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Error summary 
data
 null Always null 
errors
 array Diagnostic notes (if any)

500 Internal Server Error 


{ 
 	"success": false, 
	"message": "Something went wrong!", 
	"data": null, 
	"errors": [ 
		"Please contact administrator." 
	] 
}

4. View All Customers

Using this API, you can retrieve a list of all customers available in the system.

Request Parameters

The following are the request parameters for GET /api/v1/customer/all:
Table 7. Headers
Field Data Type Required Description
Authorization string Yes Bearer token obtained from login.
Content-Type string Yes Media type of the request.
Table 8. Query Parameters
Field Data Type Required Default Description 
nameQuery
 string No — General search term to filter customers. 
customerType
 string No — Filter customers by type (customer or business). 
pageNumber
 int No 1 Page number for paginated results. Must be > 0. 
pageSize
 int No 10 Number of items per page (1–100). 
orderBy
 string No CreatedDate Field used for sorting results. 
order
 string No DESC Sort direction (ASC or DESC).

Request

GET /api/v1/customer/all?pageNumber=1&pageSize=10&orderBy=CreatedDate&order=DESC
Authorization: Bearer <accessToken>
Content-Type: application/json

Response Parameters

The following are the response parameters for GET /api/v1/customer/all:

200 OK
Table 9. Top-level fields:
Field Data Type Description 
success
 boolean Indicates if the request was successful. 
message
 string Response message. 
data
 object Contains pagination info and records. 
errors
 object|null Null on success.
Table 10. data object:
Field Data Type Description 
pageNumber
 int Current page number. 
pageSize
 int Number of records returned per page. 
totalRecords
 int Total number of customers available. 
records
 array List of customer records.
Table 11. records[] object
Field Data Type Description 
id
 string Unique customer ID. 
firstName
 string Customer’s first name. 
lastName
 string Customer’s last name. 
email
 string Customer’s email. 
phoneNumber
 string Customer’s phone number. 
createdDate
 string Account creation date (ISO-8601).

Response


{ 
  "success": true, 
  "message": "Customers retrieved successfully.", 
  "data": { 
    "pageNumber": 1, 
    "pageSize": 10, 
    "totalRecords": 2, 
    "records": [ 
      { 
        "id": "70bf0dcb-2deb-462e-852b-ea5a6f15e99a", 
        "firstName": "John", 
        "lastName": "Doe", 
        "email": "john.doe@example.com", 
        "phoneNumber": "1234567890", 
        "createdDate": "2025-08-14T15:26:21.5302871Z" 
      } 
    ] 
  }, 
  "errors": null 
}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request for GET /api/v1/customer/all:

Table 12. Top-level fields:
Field Data Type Description 
success
 boolean Always false for bad requests. 
message
 string Error message. 
data
 null Always null. 
errors
 array List of validation error messages.

400 Bad Request


{ 
  "success": false, 
  "message": "Bad Request", 
  "data": null, 
  "errors": [ 
    "Invalid request parameters.", 
    "PageNumber must be greater than 0." 
  ] 
}

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error for GET /api/v1/customer/all:
Table 13. Top-level fields:
Field Data Type Description 
success
 boolean Always false. 
message
 string Server error message. 
data
 null Always null. 
errors
 array Error details if provided.

500 Internal Server Error 


{ 
 	"success": false, 
	"message": "Something went wrong!", 
	"data": null, 
	"errors": [ 
		"Please contact administrator." 
	] 
}

5. Find a Customer by ID

Using this API, users can fetch the details of a specific customer using their unique ID.

Request Parameters

The following are the request parameters for GET /api/v1/customer/{customerId}:
Table 14. Headers
Field Data Type Required Description
Authorization string Yes Bearer token obtained from login.
Content-Type string Yes Media type of the request.
Field Data Type Required Description Example 
customerId
 string Yes Unique identifier of customer fb82911d-900a-409f-a140-7cb9a7c73084

Request

GET /api/v1/customer/fb82911d-900a-409f-a140-7cb9a7c73084
Authorization: Bearer <accessToken>
Content-Type: application/json

Response Parameters

The following are the response parameters for GET /api/v1/customer/{customerId}:

200 OK
Table 15. Top-level fields:
Field Data Type Description 
success
 boolean Request status 
message
 string Outcome message 
data
 object Customer record 
errors
 null Null on success
Table 16. data object:
Field Type Description 
id
 string Customer ID (GUID) 
userName
 string Username 
password
 string Password (as returned by API) 
companyName
 string Company name 
customerType
 number Customer type code 
firstName
 string First name 
lastName
 string Last name 
phoneType
 string Phone type 
phoneNumber
 string Phone number 
email
 string Email address 
addressLine1
 string Address line 1 
addressLine2
 string Address line 2 
city
 string City 
state
 string State/Province 
postalCode
 string Postal/ZIP code 
country
 string Country 
employer
 string Employer 
occupation
 string Occupation 
monthlyIncome
 number Monthly income 
payFrequency
 string Pay frequency 
driversLicense
 string Driver’s license 
dob
 string Date of birth (ISO-8601) 
ssn
 string SSN 
bankName
 string Bank name 
bankAccNo
 string Bank account number 
routingNo
 string Routing number 
ein
 string Employer Identification Number 
employerName
 string Employer legal name 
isActive
 boolean Active status 
createdDate
 string Created timestamp (ISO-8601) 
updatedDate
 string Last updated timestamp (ISO-8601)

Response


{ 
  "success": true, 
  "message": "Record retrieved successfully.", 
  "data": { 
    "id": "fb82911d-900a-409f-a140-7cb9a7c73084", 
    "userName": "johndoe", 
    "password": "SecurePassword123", 
    "companyName": "AcuCheck Inc.", 
    "customerType": 1, 
    "firstName": "John", 
    "lastName": "Doe", 
    "phoneType": "Mobile", 
    "phoneNumber": "+1-234-567-8901", 
    "email": "johndoe@example.com", 
    "addressLine1": "123 Main St", 
    "addressLine2": "Apt 4B", 
    "city": "New York", 
    "state": "NY", 
    "postalCode": "10001", 
    "country": "USA", 
    "employer": "TechCorp", 
    "occupation": "Software Engineer", 
    "monthlyIncome": 7500, 
    "payFrequency": "Monthly", 
    "driversLicense": "D1234567", 
    "dob": "1990-05-15T00:00:00.0000000Z", 
    "ssn": "123-45-6789", 
    "bankName": "Bank of America", 
    "bankAccNo": "1234567890", 
    "routingNo": "021000021", 
    "ein": "12-3456789", 
    "employerName": "TechCorp", 
    "isActive": true, 
    "createdDate": "2024-08-14T15:26:21.5404772Z", 
    "updatedDate": "2025-08-14T15:26:21.5404788Z" 
  }, 
  "errors": null 
}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request for GET /api/v1/customer/{customerId}:
Table 17. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Error summary 
data
 null Always null 
errors
 array Error details

400 Bad Request


{ 
	  "success": false, 
	  "message": "Not found", 
	  "data": null, 
	  "errors": [ 
		    "Customer not found." 
  	] 
}

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error for GET /api/v1/customer/{customerId}:
Table 18. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Error summary 
data
 null Always null 
errors
 array Diagnostic/help message

500 Internal Server Error 


{ 
       "success": false, 
	"message": "Something went wrong!", 
	"data": null, 
	"errors": [ 
		"Please contact administrator." 
	] 
}

6. Update Customer Information

Using this API, users can update the general information for an existing customer.

Request Parameters

The following are the request parameters for PUT /api/v1/customer/information:
Table 19. Headers
Field Data Type Required Description
Authorization string Yes Bearer token from login
Content-Type string Yes Media type
Table 20. Body
Field Data Type Required Description 
id
 string Yes Customer ID (GUID) 
customerType
 number Yes 1 = customer, 2 = business 
companyName
 string No* Business name (use only when customerType = 2) 
firstName
 string Yes First name 
lastName
 string Yes Last name 
addressLine1
 string Yes Address line 1 
addressLine2
 string No Address line 2 
city
 string Yes City 
state
 string Yes State/Province 
postalCode
 string Yes Postal/ZIP code (≤ 10 chars) 
driversLicense
 string No 5–20 alphanumeric 
ssn
 string Yes 9 digits (no dashes) 
country
 string Yes Country 
dob
 string Yes ISO-8601 date/time and must be in the past 
ein
 string No* EIN (use only when customerType = 2)

Request


{ 
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 
  "customerType": 1, 
  "companyName": "string", 
  "firstName": "string", 
  "lastName": "string", 
  "addressLine1": "string", 
  "addressLine2": "string", 
  "city": "string", 
  "state": "string", 
  "postalCode": "string", 
  "driversLicense": "string", 
  "ssn": "string", 
  "country": "string", 
  "dob": "2025-08-14T15:50:45.034Z", 
  "ein": "string" 
}

Response Parameters

The following are the response parameters for PUT /api/v1/customer/information:

200 OK
Table 21. Top-level fields:
Field Data Type Description 
success
 boolean Operation status 
message
 string Outcome message 
data
 object Updated customer record 
errors
 null Null on success
Table 22. data object:
Field Data Type Description 
id
 string Customer ID (GUID) 
customerType
 number 1 = customer, 2 = business 
companyName
 string Business name 
firstName
 string First name 
lastName
 string Last name 
addressLine1
 string Address line 1 
addressLine2
 string Address line 2 
city
 string City 
state
 string State/Province 
postalCode
 string Postal/ZIP code 
driversLicense
 string Driver’s license 
ssn
 string SSN (as returned) 
country
 string Country 
dob
 string Birthdate (ISO-8601) 
ein
 string EIN

Response


{ 
  "success": true, 
  "message": "Customer information updated successfully.", 
  "data": { 
    "id": "75315ef2-4d85-42ef-bf04-a3b73b635dea", 
    "customerType": 1, 
    "companyName": "Acme Corp", 
    "firstName": "Jane", 
    "lastName": "Doe", 
    "addressLine1": "456 Elm Street", 
    "addressLine2": "Suite 5A", 
    "city": "Gotham", 
    "state": "CA", 
    "postalCode": "90210", 
    "driversLicense": "D1234567", 
    "ssn": "123-45-6789", 
    "country": "USA", 
    "dob": "1985-08-15T00:00:00.0000000Z", 
    "ein": "12-3456789" 
  }, 
  "errors": null 
}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request for PUT /api/v1/customer/information:
Table 23. Top-level fields:
Field Data Type Description
success boolean Always false
message string Error summary
data null Always null
errors array Validation messages

400 Bad Request


{ 
  "success": false, 
  "message": "Validation failed for the request.", 
  "data": null, 
  "errors": [ 
    "Customer type must be either 'customer' or 'business'.", 
    "Postal code must not exceed 10 characters.", 
    "First name is required.", 
    "Last name is required.", 
    "Date of Birth must be in the past.", 
    "SSN must be exactly 9 digits.", 
    "Driver's License must be 5 to 20 alphanumeric characters." 
  ] 
}

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error for PUT /api/v1/customer/information:
Table 24. Top-level fields:
Field Data Type Description
success boolean Always false
message string Server error message
data null Always null
errors array Diagnostic/help message

500 Internal Server Error 


{ 
 	"success": false, 
	"message": "Something went wrong!", 
	"data": null, 
	"errors": [ 
		"Please contact administrator." 
	] 
}

7. Update Customer Bank Details

This API enables you to change or add bank account details for a customer.

Request Parameters

The following are the request parameters for PUT /api/v1/customer/bank-information:
Table 25. Headers
Field Data Type Required Description
Authorization string Yes Bearer token from login
Content-Type string Yes Media type
Table 26. Body
Field Data Type Required Description 
id
 string Yes Customer ID (GUID) 
bankName
 string Yes Bank name (≤ 100 characters) 
bankAccNo
 string Yes Bank account number (6–17 digits only) 
routingNo
 string Yes Routing number (exactly 9 digits)
Request

{ 
	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 
	"bankName": "string", 
	"bankAccNo": "81526962681303286", 
       "routingNo": "697876632" 
}

Response Parameters

The following are the response parameters for PUT /api/v1/customer/bank-information:

200 OK
Table 27. Top-level fields:
Field Data Type Description 
success
 boolean Operation status 
message
 string Outcome message 
data
 object Updated bank information 
errors
 null Null on success
Table 28. data object:
Field Type Description 
id
 string Customer ID (GUID) 
bankName
 string Bank name 
bankAccNo
 string Bank account number 
routingNo
 string Routing number

Response


{ 
  "success": true, 
  "message": "Customer bank information updated successfully.", 
  "data": { 
    "id": "b6969794-8561-432e-b187-482d354fef8c", 
    "bankName": "Bank of America", 
    "bankAccNo": "123456789012", 
    "routingNo": "987654321" 
  }, 
  "errors": null 
}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request for PUT /api/v1/customer/bank-information:
Table 29. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Error summary 
data
 null Always null 
errors
 array Validation error messages

400 Bad Request


{ 
  "success": false, 
  "message": "Validation failed for the request.", 
  "data": null, 
  "errors": [ 
    "Customer ID is required.", 
    "Bank Account Number must be at least 6 digits.", 
    "Bank Account Number must not exceed 17 digits.", 
    "Bank Account Number must contain only digits.", 
    "Routing number must be exactly 9 digits.", 
    "Bank name must not exceed 100 characters." 
  ] 
}

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error for PUT /api/v1/customer/bank-information:
Table 30. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Server error message 
data
 null Always null 
errors
 array Diagnostic/help message

500 Internal Server Error 


{ 
 	"success": false, 
	"message": "Something went wrong!", 
	"data": null, 
	"errors": [ 
		"Please contact administrator." 
	] 
}

8. Update Customer Contact Details

Using this API, you can modify the contact information of a customer.

Request Parameters

The following are the request parameters for PUT /api/v1/customer/contact-information:
Table 31. Headers
Field Data Type Required Description
Authorization string Yes Bearer token from login
Content-Type string Yes Media type of request body
Table 32. Body
Field Data Type Required Description 
id
 string Yes Customer ID (GUID) 
customerType
 number Yes 1 = customer, 2 = business 
firstName
 string Cond.* First name (see validation rules below) 
lastName
 string Cond.* Last name (see validation rules below) 
phoneNumber
 string Yes Phone number (exactly 10 digits) 
email
 string Yes Email address (valid format, ≤ 50 chars)
Note:
Conditional Requirements:
  • For 
    customerType = 2
      (business)
    : firstName and lastName required and must be ≤ 50 chars.
  • For 
    customerType = 1
      (customer)
    : some validations may require firstName/lastName to be null.

Request


{ 
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 
  "customerType": 1, 
  "firstName": "string", 
  "lastName": "string", 
  "phoneNumber": "1234567890", 
  "email": "user@example.com" 
}

Response Parameters

The following are the response parameters for PUT /api/v1/customer/contact-information:

200 OK
Table 33. Top-level fields:
Field Data Type Description 
success
 boolean Operation status 
message
 string Outcome message 
data
 object Updated contact information 
errors
 null Null on success
Table 34. data object
Field Data Type Description 
id
 string Customer ID (GUID) 
customerType
 number 1 = customer, 2 = business 
firstName
 string First name 
lastName
 string Last name 
phoneNumber
 string Phone number (10 digits) 
email
 string Email address

Response


{ 
  "success": true, 
  "message": "Customer contact information updated successfully.", 
  "data": { 
    "id": "6a3f2ae0-1df5-43ff-9cb5-4c6fc8354553", 
    "customerType": 2, 
    "firstName": "James", 
    "lastName": "D", 
    "phoneNumber": "1234567890", 
    "email": "updated.email@example.com" 
  }, 
  "errors": null 
}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request for PUT /api/v1/customer/contact-information:
Table 35. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Error summary 
data
 null Always null 
errors
 array Validation error messages

400 Bad Request


{ 
  "success": false, 
  "message": "Validation failed for the request.", 
  "data": null, 
  "errors": [ 
    "Customer ID is required.", 
    "CustomerType must be either 'customer' or 'business'.", 
    "Email is required.", 
    "Invalid email format.", 
    "Email must not exceed 50 characters.", 
    "Phone number is required.", 
    "Phone number must be exactly 10 digits.", 
    "First name is required.", 
    "First name must not exceed 50 characters.", 
    "Last name is required.", 
    "Last name must not exceed 50 characters.", 
    "First name must be null for customer type 'customer'.", 
    "Last name must be null for customer type 'customer'." 
  ] 
}

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error for PUT /api/v1/customer/contact-information:
Table 36. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Server error message 
data
 null Always null 
errors
 array Diagnostic/help message

500 Internal Server Error 


{ 
      "success": false, 
	"message": "Something went wrong!", 
	"data": null, 
	"errors": [ 
		"Please contact administrator." 
	] 
}

9. Update Customer Employment Details

This API enables you to update the employment and job-related details of a customer.

Request Parameters

The following are the request parameters for PUT /api/v1/customer/employee-information:
Table 37. Headers
Field Data Type Required Description
Authorization string Yes Bearer token from login
Content-Type string Yes Media type of request body
Table 38. Body
Field Type Required Description 
id
 string Yes Customer ID (GUID) 
customerType
 number Yes Must be 1 (customer). Validation fails if not. 
payFrequency
 string Yes Pay frequency; must be one of: Monthly, Bi-Monthly, Weekly, Bi-Weekly 
employerName
 string Yes Employer’s legal name; ≤ 100 characters

Request


{ 
	  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 
	  "customerType": 1, 
	  "payFrequency": "string", 
  	"employerName": "string" 
}

Response Parameters

The following are the response parameters for PUT /api/v1/customer/employee-information:

200 OK
Table 39. Top-level fields:
Field Data Type Description 
success
 boolean Operation status 
message
 string Outcome message 
data
 object Updated employee information 
errors
 null Null on success
Table 40. data object:
Field Data Type Description 
id
 string Customer ID (GUID) 
payFrequency
 string Pay frequency 
employerName
 string Employer’s legal name

Response


{ 
  "success": true, 
  "message": "Employee information updated successfully.", 
  "data": { 
    "id": "afac1ffd-c103-4f8d-96f2-664ff035c337", 
    "payFrequency": "Monthly", 
    "employerName": "Tech Solutions Pvt. Ltd." 
  }, 
  "errors": null 
}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request for PUT /api/v1/customer/employee-information:
Table 41. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Error summary 
data
 null Always null 
errors
 array Validation error messages

400 Bad Request


{ 
  "success": false, 
  "message": "Validation failed for the request.", 
  "data": null, 
  "errors": [ 
    "Customer Id is required.", 
    "Customer type must be 'customer'.", 
    "Employer name must not exceed 100 characters.", 
    "Pay Frequency must be one of the following: Monthly, Bi-Monthly, Weekly, Bi-Weekly." 
  ]

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error for PUT /api/v1/customer/employee-information:
Table 42. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Server error message 
data
 null Always null 
errors
 array Diagnostic/help message

500 Internal Server Error 


{ 
 	"success": false, 
	"message": "Something went wrong!", 
	"data": null, 
	"errors": [ 
		"Please contact administrator." 
	] 
}

10. Request a New Report

This API enables you to create and submit a new report request for analysis.

Request Parameters

The following are the request parameters for POST /api/v1/instantbankanalysis/report-request:
Table 43. Headers
Field Data Type Required Description
Authorization string Yes Bearer token from login
Content-Type string Yes Media type of request body
Table 44. Body
Field Type Required Description 
customerId
 string Yes Customer ID (GUID) for which the report is generated 
sendVia
 number Yes Delivery channel (enum: e.g., 1 = email, 2 = SMS, etc.)

Request


{ 
	"customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 
  	"sendVia": 1 
}

Response Parameters

The following are the response parameters for POST /api/v1/instantbankanalysis/report-request:

200 OK
Table 45. Top-level fields:
Field Data Type Description 
success
 boolean Operation status 
message
 string Outcome message 
data
 string Unique identifier of the report request (GUID) 
errors
 null Null on success

Response


{ 
	"success": true, 
	"message": "Report request created successfully. A verification email has been sent to the customer.", 
	"data": "ab63acb6-1931-4147-80e8-4335fe0f77d4", 
  	"errors": null 
}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request for POST /api/v1/instantbankanalysis/report-request:
Table 46. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Error summary 
data
 null Always null 
errors
 array Validation or failure messages

400 Bad Request


{ 
	  "success": false, 
	  "message": "Report request failed.", 
	  "data": null, 
	  "errors": [ 
  		"Customer not found." 
  	  ] 
}

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error for POST /api/v1/instantbankanalysis/report-request:
Table 47. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Server error message 
data
 null Always null 
errors
 array Diagnostic/help message

500 Internal Server Error


{ 
 	"success": false, 
	"message": "Something went wrong!", 
	"data": null, 
	"errors": [ 
		"Please contact administrator." 
	] 
}

11. View All Report Requests

Using this API, you can retrieve a list of all report requests submitted under your account.

Request Parameters

The following are the request parameters for GET /api/v1/instantbankanalysis/report-requests:
Table 48. Headers
Field Data Type Required Description
Authorization string Yes Bearer token obtained from login
Content-Type string Yes Media type of the request
Table 49. Query Parameters
Field Type Required Default Description 
nameQuery
 string No — General search term to filter report requests 
customerType
 string No — Filter by customer type (customer, business, etc.) 
status
 string No — Report request status (implementation-defined enum/code) 
orderedDateFrom
 string No — Filter: report ordered date (from). ISO-8601 
orderedDateTo
 string No — Filter: report ordered date (to). ISO-8601 
onBoardedDateFrom
 string No — Filter: customer onboarded date (from). ISO-8601 
onBoardedDateTo
 string No — Filter: customer onboarded date (to). ISO-8601 
pageNumber
 int No 1 Page number for paginated results (must be > 0) 
pageSize
 int No 10 Items per page (1–100) 
orderBy
 string No CreatedDate Field to sort by 
order
 string No DESC Sort direction (ASC or DESC)

Request

GET /api/v1/instantbankanalysis/report-requests?nameQuery=Jane&status=1&orderedDateFrom=2025-08-01T00:00:00Z&orderedDateTo=2025-08-31T23:59:59Z&pageNumber=1&pageSize=10&orderBy=CreatedDate&order=DESC
Authorization: Bearer <accessToken>
Content-Type: application/json

Response Parameters

The following are the response parameters for GET /api/v1/instantbankanalysis/report-requests:

200 OK
Table 50. Top-level fields:
Field Data Type Description 
success
 boolean Indicates if the request was successful 
message
 string Response message 
data
 object Paginated report request list 
errors
 null Null on success
Table 51. data object
Field Data Type Description 
pageNumber
 int Current page number 
pageSize
 int Number of items per page 
totalRecords
 int Total number of report requests available 
records
 array Array of report request records
Table 52. records[]object
Field Data Type Description 
id
 string Report request ID (GUID) 
customerId
 string Associated customer ID 
firstName
 string Customer first name 
lastName
 string Customer last name 
phoneNumber
 string Customer phone number 
sentVia
 number Delivery channel (e.g., 1 = email, 2 = SMS, etc.) 
status
 number Report request status (implementation-defined enum) 
startDate
 string Report start date (ISO-8601) 
endDate
 string Report end date (ISO-8601, nullable) 
createdDate
 string When the request was created (ISO-8601) 
onboardedDate
 string Customer onboarded date (ISO-8601, nullable) 
reportScore
 number|null Report score, if generated 
createdBy
 string Email of the user who created the request 
email
 string|null Email used for sending the report (if applicable) 
reportNumber
 string|null Report number (if generated)

Response


{ 
  "success": true, 
  "message": "Success", 
  "data": { 
    "pageNumber": 1, 
    "pageSize": 10, 
    "totalRecords": 100, 
    "records": [ 
 
     	 { 
	        "id": "188cf01a-ed91-4152-bc2d-24f3c625808d", 
	        "customerId": "00000000-0000-0000-0000-000000000000", 
	        "firstName": "Jane", 
	        "lastName": "Smith", 
	        "phoneNumber": "+1-987-654-3210", 
	        "sentVia": 2, 
	        "status": 1, 
	        "startDate": "2025-08-07T15:26:21.1782283Z", 
	        "endDate": null, 
	        "createdDate": "2025-08-07T15:26:21.1782284Z", 
	        "onboardedDate": "0001-01-01T00:00:00.0000000Z", 
	        "reportScore": null, 
	        "createdBy": "supervisor@example.com", 
	        "email": null, 
	        "reportNumber": null 
      } 
    ] 
  }, 
  "errors": null 
}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request for GET /api/v1/instantbankanalysis/report-requests:
Table 53. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Error summary 
data
 null Always null 
errors
 array Validation or request error list

400 Bad Request


{ 
	  "success": false, 
	  "message": "Bad Request", 
	  "data": null, 
	  "errors": [ 
		    "Invalid request parameters.", 
		    "PageNumber must be greater than 0." 
	  ] 
}

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error for GET /api/v1/instantbankanalysis/report-requests:
Table 54. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Server error message 
data
 null Always null 
errors
 array Diagnostic/help message

500 Internal Server Error 


{ 
 	"success": false, 
	"message": "Something went wrong!", 
	"data": null, 
	"errors": [ 
		"Please contact administrator." 
	] 
}

12. Resend an Expired Report Request

You can use this API to send a fresh request when a previously issued report request has expired.

Request Parameters

The following are the request parameters for POST /api/v1/instantbankanalysis/report-request/reset:
Table 55. Headers
Field Data Type Required Description
Authorization string Yes Bearer token from login
Content-Type string Yes Media type of request body
Table 56. Body
Field Type Required Description 
reportRequestId
 string Yes Report request ID (GUID) to resend

Request


{ 
  	"reportRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 
}

Response Parameters

The following are the response parameters for POST /api/v1/instantbankanalysis/report-request/reset:

200 OK
Table 57. Top-level fields:
Field Data Type Description 
success
 boolean Operation status 
message
 string Outcome message 
data
 string Unique identifier of the re-sent request (GUID) 
errors
 null Null on success

Response


{ 
	  "success": true, 
	  "message": "Report request re-sent successfully.", 
	  "data": "32294c18-5735-46fc-8155-b317cf10815d", 
	  "errors": null 
}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request for POST /api/v1/instantbankanalysis/report-request/reset:
Table 58. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Error summary 
data
 null Always null 
errors
 array Validation or lookup error list

400 Bad Request


{ 
  "success": false, 
  "message": "Not found.", 
  "data": null, 
  "errors": [ 
    "Report request not found." 
  ] 
}

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error for POST /api/v1/instantbankanalysis/report-request/reset:
Table 59. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Server error message 
data
 null Always null 
errors
 array Diagnostic/help message

500 Internal Server Error 


{ 
 	"success": false, 
	"message": "Something went wrong!", 
	"data": null, 
	"errors": [ 
		"Please contact administrator." 
	] 
}

13. View Report Request Details by Report ID

Using this API, you can get the detailed information of a specific report request using its ID.

Request Parameters

The following are the request parameters for GET /api/v1/instantbankanalysis/reportrequests/{reportId}:
Table 60. Headers
Field Data Type Required Description
Authorization string Yes Bearer token obtained from login
Content-Type string Yes Media type of request
Table 61. Path Parameters
Field Data Type Required Description 
reportId
 string Yes Unique identifier of the report request

Request

GET /api/v1/instantbankanalysis/reportrequests/ae6e68fd-ff87-47f5-b3ae-2477c189cea2
Authorization: Bearer <accessToken>
Content-Type: application/json

Response Parameters

The following are the response parameters for GET /api/v1/instantbankanalysis/reportrequests/{reportId}:

200 OK
Table 62. Top-level fields:
Field Data Type Description 
success
 boolean Indicates if the request was successful 
message
 string Response message 
data
 object Report request details 
errors
 null Null on success
Table 63. data object
Field Type Description 
id
 string Unique identifier of the report request 
reportNumber
 string System-generated report number 
requestType
 number Type of report request (implementation-specific enum) 
status
 number Report request status (implementation-specific enum) 
customerId
 string ID of the customer linked to the report request 
merchantId
 string Merchant identifier 
sentVia
 number Delivery channel (e.g., 1 = email, 2 = SMS) 
reportScore
 number Report score value (if applicable) 
createdDate
 string When the report request was created (ISO-8601) 
updatedDate
 string When the report request was last updated (ISO-8601) 
startDate
 string Report’s effective start date (ISO-8601) 
endDate
 string Report’s effective end date (ISO-8601)

Response


{ 
  "success": true, 
  "message": "Request successful", 
  "data": { 
    "id": "ae6e68fd-ff87-47f5-b3ae-2477c189cea2", 
    "reportNumber": "144SXPAA6S", 
    "requestType": 1, 
    "status": 1, 
    "customerId": "2d3759f2-aef7-4a61-97d6-2cf8dc4aeb28", 
    "merchantId": "GLO51671", 
    "sentVia": 2, 
    "reportScore": 0, 
    "createdDate": "2025-08-13T22:49:09.8430000Z", 
    "updatedDate": null, 
    "startDate": "2023-08-13T22:49:09.8430000Z", 
    "endDate": "2025-08-13T22:49:09.8430000Z" 
  }, 
  "errors": null 
}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request for GET /api/v1/instantbankanalysis/reportrequests/{reportId}:
Table 64. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Error summary 
data
 null Always null 
errors
 array Error messages
400 Bad Request

{ 
	  "success": false, 
	  "message": "Report request failed.", 
	  "data": null, 
	  "errors": [ 
  		"Report not found." 
  	  ] 
}

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error for GET /api/v1/instantbankanalysis/reportrequests/{reportId}:
Table 65. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Server error message 
data
 null Always null 
errors
 array Diagnostic/help message

500 Internal Server Error 

{ 
 	"success": false, 
	"message": "Something went wrong!", 
	"data": null, 
	"errors": [ 
		"Please contact administrator." 
	] 
}

14. View Bank Account Details by Report ID

This API enables you to retrieve the bank account details linked to a given report ID.

Request Parameters

The following are the request parameters for GET /api/v1/instantbankanalysis/GetBankAccountByReportId/{reportId}:
Table 66. Headers
Field Data Type Required Description
Authorization string Yes Bearer token obtained from login
Content-Type string Yes Media type of request
Table 67. Path Parameter
Field Data Type Required Description 
reportId
 string Yes Unique identifier of the report request

Request

GET /api/v1/instantbankanalysis/GetBankAccountByReportId/8e04133c-8b4e-4961-94a3-6151835d0b2e
Authorization: Bearer <accessToken>
Content-Type: application/json

Response Parameters

The following are the response parameters for GET /api/v1/instantbankanalysis/GetBankAccountByReportId/{reportId}:

200 OK
Table 68. Top-level fields:
Field Data Type Description 
success
 boolean Indicates if the request was successful 
message
 string Response message 
data
 array List of bank account details for the report 
errors
 null Null on success
Table 69. data[] object
Field Data Type Description 
id
 string Unique identifier of the bank account record (GUID) 
accountId
 number Internal account identifier 
accountType
 string Type of account 
reportId
 string Associated report request ID 
financialInstitutionLoginAccountId
 string Financial institution login account ID 
financialInstitutionName
 string Name of the financial institution 
country
 string Country of the account 
financialInstitutionId
 string Financial institution identifier 
financialInstitutionHarvestStatus
 string Status of account connection/harvesting 
lastFourDigitsOfAccountNumber
 string Masked account number (last 4 digits visible) 
accountOwnerName
 string Owner of the account 
externalAccountType
 string External account type code 
accountName
 string Account name at financial institution 
nameOnAccount
 string Name on the account 
lastSuccessfulUpdate
 string Last successful data update (ISO-8601) 
currentBalance
 number Current balance 
availableBalance
 number Available balance 
merchantId
 string Merchant ID associated with this account 
createdDate
 string Record creation date (ISO-8601)

Response


{ 
  "success": true, 
  "message": "Request successful", 
  "data": { 
    "id": "ae6e68fd-ff87-47f5-b3ae-2477c189cea2", 
    "reportNumber": "144SXPAA6S", 
    "requestType": 1, 
    "status": 1, 
    "customerId": "2d3759f2-aef7-4a61-97d6-2cf8dc4aeb28", 
    "merchantId": "GLO51671", 
    "sentVia": 2, 
    "reportScore": 0, 
    "createdDate": "2025-08-13T22:49:09.8430000Z", 
    "updatedDate": null, 
    "startDate": "2023-08-13T22:49:09.8430000Z", 
    "endDate": "2025-08-13T22:49:09.8430000Z" 
  }, 
  "errors": null 
}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request for GET /api/v1/instantbankanalysis/GetBankAccountByReportId/{reportId}:
Table 70. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Error summary 
data
 null Always null 
errors
 array Error details

400 Bad Request


{ 
	  "success": false, 
	  "message": "Report request failed.", 
	  "data": null, 
	  "errors": [ 
  		"Report not found." 
  	  ] 
}

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error for GET /api/v1/instantbankanalysis/GetBankAccountByReportId/{reportId}:
Table 71. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Server error message 
data
 null Always null 
errors
 array Diagnostic/help message

500 Internal Server Error 


{ 
 	"success": false, 
	"message": "Something went wrong!", 
	"data": null, 
	"errors": [ 
		"Please contact administrator." 
	] 
}

15. Generate Financial Report by Report Id

Request Parameters

The following are the request parameters for GET /api/v1/instantbankanalysis/financialreport:
Table 72. Headers
Field Data Type Required Description
Authorization string Yes Bearer token obtained from login
Content-Type string Yes Media type of request
Table 73. Query Parameters
Field Data Type Required Description 
reportId
 string Yes Unique identifier of the report request

Request

GET /api/v1/instantbankanalysis/financialreport?reportId=b499e894-59ce-44ed-9973-f8e134d218d7
Authorization: Bearer <accessToken>
Content-Type: application/json

Response Parameters

The following are the response parameters for GET /api/v1/instantbankanalysis/financialreport:

200 OK
Table 74. Top-level fields:
Field Data Type Description Example 
success
 boolean Indicates if the request was successful. true 
message
 string Response message. Request successful 
data
 object Financial report payload. {...} 
errors
 null Null on success. null
Table 75. data object (financial report summary & aggregates)
Field Data Type Description 
financialReportId
 string Unique identifier for this financial report (GUID). 
score
 number Overall report score. 
availableBalance
 number Available balance across evaluated accounts. 
currentBalance
 number Current balance across evaluated accounts. 
averageIncomePerMonth
 number Average monthly income. 
averageAnnualIncome
 number Average annual income. 
averageExpensesPerMonth
 number Average monthly expenses. 
debtToIncomeRatio
 number Debt-to-income ratio (percentage or value per implementation). 
disposableIncome
 number Monthly disposable income. 
averageDailyBalance
 number Average daily balance. 
incomeProbability
 number Probability of income continuity (0–100). 
monthlyAbilityToPay
 number Estimated monthly ability to pay. 
biWeeklyAbilityToPay
 number Estimated bi-weekly ability to pay. 
firstTransactionDate
 string First transaction date considered (ISO-8601). 
likelyEmployerResults
 array Detected likely employers and their related transactions. 
monthlyExpenditures
 array Monthly expenditure items. 
potentialLoans
 array Potential loan matches with supporting transactions. 
monthlyExpense
 number Total monthly expense (aggregate).
Nested Objects:
Table 76. data.likelyEmployerResults[] object
Field Data Type Description 
likelyEmployerResultId
 string Identifier for the employer result (GUID). 
employerName
 string Detected employer name. 
occurrenceCount
 number Number of income occurrences attributed to this employer. 
frequency
 string Pay frequency (e.g., Bi-Weekly). 
financialReportId
 string Linked financial report ID (may be zero GUID). 
duration
 string Duration string (e.g., “1 year(s)”). 
transactions
 array Transactions supporting this employer detection. 
financialReport
 null Placeholder (null in current response).
Table 77. data.likelyEmployerResults[].transactions[] object
Field Data Type Description 
id
 string Transaction record ID (GUID). 
accountSummaryId
 string Account summary ID (GUID). 
merchantId
 string Merchant/tenant identifier. 
requestUniqueId
 string Report request unique ID (GUID). 
accountId
 number Core banking account identifier. 
transactionId
 number Upstream transaction identifier. 
transactionType
 string Credit or Debit. 
postedDate
 string Transaction posted date (ISO-8601). 
createdOnDate
 string Record creation date (ISO-8601). 
amount
 number Transaction amount (credits usually positive). 
currencyCode
 string Currency code (ISO 4217). 
memo
 string Transaction memo/description. 
category
 string Category label. 
subCategory
 string Sub-category label. 
isActive
 boolean Activity flag. 
createdDate
 string Created timestamp (ISO-8601). 
createdBy
 string Creator (e.g., System). 
updatedBy
 string | null Last updater if any. 
updatedDate
 string | null Last update timestamp (ISO-8601) or null. 
deletedDate
 string | null Deletion timestamp (ISO-8601) or null.
Table 78. data.monthlyExpenditures[] object
Field Data Type Description 
monthlyExpenditureId
 string Expenditure record ID (GUID). 
category
 string Expenditure category. 
totalSpent
 number Total spent for the month in this category. 
datePaid
 string Payment date (ISO-8601). 
memo
 string Payment memo/description. 
financialReportId
 string Linked report ID (may be zero GUID). 
financialReport
 null Placeholder (null in current response).
Table 79. data.potentialLoans[] object
Field Data Type Description 
loanMatchId
 string Loan match identifier (GUID, may be zero GUID). 
creditTransaction
 object Credit (disbursement) transaction details. 
debitTransactions
 array Related debit (repayment) transactions. 
detectedCompanyName
 string Detected lender/company name. 
confidenceScore
 number Confidence score (0–1).
Table 80. data.potentialLoans[].creditTransaction object
Field Data Type Description 
id
 string Transaction record ID (GUID). 
accountSummaryId
 string Account summary ID (GUID). 
merchantId
 string Merchant/tenant identifier. 
requestUniqueId
 string Report request unique ID (GUID). 
accountId
 number Core banking account identifier. 
transactionId
 number Upstream transaction identifier. 
transactionType
 string Credit. 
postedDate
 string Posted date (ISO-8601). 
createdOnDate
 string Record creation date (ISO-8601). 
amount
 number Amount (positive for credit). 
currencyCode
 string Currency code (ISO 4217). 
memo
 string Memo (e.g., disbursement descriptor). 
category
 string Category label. 
subCategory
 string Sub-category label. 
isActive
 boolean Activity flag. 
createdDate
 string Created timestamp (ISO-8601). 
createdBy
 string Creator (e.g., System). 
updatedBy
 string | null Last updater if any. 
updatedDate
 string | null Last update timestamp (ISO-8601) or null. 
deletedDate
 string | null Deletion timestamp (ISO-8601) or null.
Fields match the transaction schema.
Table 81. data.potentialLoans[].debitTransactions[] object
Field Data Type Description 
id
 string Transaction record ID (GUID). 
accountSummaryId
 string Account summary ID (GUID). 
merchantId
 string Merchant/tenant identifier. 
requestUniqueId
 string Report request unique ID (GUID). 
accountId
 number Core banking account identifier. 
transactionId
 number Upstream transaction identifier. 
transactionType
 string Debit. 
postedDate
 string Posted date (ISO-8601). 
createdOnDate
 string Record creation date (ISO-8601). 
amount
 number Amount (may be negative for debit). 
currencyCode
 string Currency code (ISO 4217). 
memo
 string Memo (e.g., repayment descriptor). 
category
 string Category label. 
subCategory
 string Sub-category label. 
isActive
 boolean Activity flag. 
createdDate
 string Created timestamp (ISO-8601). 
createdBy
 string Creator (e.g., System). 
updatedBy
 string | null Last updater if any. 
updatedDate
 string | null Last update timestamp (ISO-8601) or null. 
deletedDate
 string | null Deletion timestamp (ISO-8601) or null.
Fields match the transaction schema; transactionType = Debit and amount negative in example.

Response


{ 

"success": true, 

"message": "Request successful", 

"data": { 

"financialReportId": "b499e894-59ce-44ed-9973-f8e134d218d7", 

"score": 480, 

"availableBalance": 38149.6, 

"currentBalance": 38149.6, 

"averageIncomePerMonth": 3271.03, 

"averageAnnualIncome": 39252.33, 

"averageExpensesPerMonth": 1263.15, 

"debtToIncomeRatio": 38.62, 

"disposableIncome": 2007.88, 

"averageDailyBalance": 36653.28, 

"incomeProbability": 100, 

"monthlyAbilityToPay": 2007.88, 

"biWeeklyAbilityToPay": 1003.94, 

"firstTransactionDate": "2024-01-01T00:00:00.0000000Z", 

"likelyEmployerResults": [ 

{ 

"likelyEmployerResultId": "564d83d6-0474-439e-ae0c-267c9ec1272c", 

"employerName": "TASTY BITES", 

"occurrenceCount": 38, 

"frequency": "Bi-Weekly", 

"financialReportId": "00000000-0000-0000-0000-000000000000", 

"duration": "1 year(s)", 

"transactions": [ 

{ 

"id": "9cc05114-8793-4d2e-9a12-9fdc98a2adbb", 

"accountSummaryId": "5c87a8b5-09d7-4bf2-afa1-5d5245c518e4", 

"merchantId": "GLO51671", 

"requestUniqueId": "b0ef740d-ddff-4b98-919e-6f9c6ae4753f", 

"accountId": 6442951, 

"transactionId": 32828235, 

"transactionType": "Credit", 

"postedDate": "2025-06-26T00:00:00.0000000Z", 

"createdOnDate": "2025-08-13T07:25:04.0000000Z", 

"amount": 109.25, 

"currencyCode": "USD", 

"memo": "TASTY BITES LLC DES:PART-TIME DEP", 

"category": "Misc", 

"subCategory": "Uncategorized", 

"isActive": true, 

"createdDate": "2025-08-13T07:26:01.6789625Z", 

"createdBy": "System", 

"updatedBy": null, 

"updatedDate": null, 

"deletedDate": null 

} 

], 

"financialReport": null 

} 

], 

"monthlyExpenditures": [ 

{ 

"monthlyExpenditureId": "3c8d12d1-d3af-498b-96dd-0b71db3c0ea4", 

"category": "Transfers", 

"totalSpent": 300, 

"datePaid": "2025-06-18T00:00:00.0000000Z", 

"memo": "DISCOVER CARD DES:PAYMENT", 

"financialReportId": "00000000-0000-0000-0000-000000000000", 

"financialReport": null 

} 

], 

"potentialLoans": [ 

{ 

"loanMatchId": "00000000-0000-0000-0000-000000000000", 

"creditTransaction": { 

"id": "be114d43-04af-45bc-a704-20f69e444a68", 

"accountSummaryId": "5c87a8b5-09d7-4bf2-afa1-5d5245c518e4", 

"merchantId": "GLO51671", 

"requestUniqueId": "b0ef740d-ddff-4b98-919e-6f9c6ae4753f", 

"accountId": 6442951, 

"transactionId": 32828381, 

"transactionType": "Credit", 

"postedDate": "2024-03-01T00:00:00.0000000Z", 

"createdOnDate": "2025-08-13T07:25:04.0000000Z", 

"amount": 300, 

"currencyCode": "USD", 

"memo": "Credit Union of Richmond INC DES:LOAN DISBURSEMENT", 

"category": "Transfers & Adjustments", 

"subCategory": "Credit Card Payment", 

"isActive": true, 

"createdDate": "2025-08-13T07:26:08.0236784Z", 

"createdBy": "System", 

"updatedBy": null, 

"updatedDate": null, 

"deletedDate": null 

}, 

"debitTransactions": [ 

{ 

"id": "03499eac-0b43-489d-9c93-ef2127bbab2a", 

"accountSummaryId": "5c87a8b5-09d7-4bf2-afa1-5d5245c518e4", 

"merchantId": "GLO51671", 

"requestUniqueId": "b0ef740d-ddff-4b98-919e-6f9c6ae4753f", 

"accountId": 6442951, 

"transactionId": 32828371, 

"transactionType": "Debit", 

"postedDate": "2024-03-31T00:00:00.0000000Z", 

"createdOnDate": "2025-08-13T07:25:04.0000000Z", 

"amount": -100, 

"currencyCode": "USD", 

"memo": "Credit Union of Richmond INC DES:LOAN REPAYMENT", 

"category": "Transfers & Adjustments", 

"subCategory": "Credit Card Payment", 

"isActive": true, 

"createdDate": "2025-08-13T07:26:07.6046689Z", 

"createdBy": "System", 

"updatedBy": null, 

"updatedDate": null, 

"deletedDate": null 

} 

], 

"detectedCompanyName": "Credit Union Of Richmond", 

"confidenceScore": 0.9 

} 

], 

"monthlyExpense": 2456 

}, 

"errors": null 

}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request for GET /api/v1/instantbankanalysis/financialreport:
Table 82. Top-level fields:
Field Data Type Description 
success
 boolean Always false. 
message
 string Error summary. 
data
 null Always null. 
errors
 array Error messages.

400 Bad Request


{ 
	  "success": false, 
	  "message": "Report request failed.", 
	  "data": null, 
	  "errors": [ 
  		"Customer not found." 
  	  ] 
}

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error for GET /api/v1/instantbankanalysis/financialreport:
Table 83. Top-level fields:
Field Data Type Description 
success
 boolean Always false. 
message
 string Server error message. 
data
 null Always null. 
errors
 array Diagnostic/help message.

500 Internal Server Error 


{ 
 	"success": false, 
	"message": "Something went wrong!", 
	"data": null, 
	"errors": [ 
		"Please contact administrator." 
	] 
}

16. View Banking Transactions by Account Summary ID

Using this API you can fetch a list of banking transactions linked to an account summary ID.

Request Parameters

The following are the request parameters for GET /api/v1/instantbankanalysis/BankingTransactions/{ReportId}/{AccountId}:
Table 84. Headers
Field Data Type Required Description
Authorization string Yes Bearer token obtained from login
Content-Type string Yes Media type of request
Table 85. Path Parameters
Field Data Type Required Description 
ReportId
 string Yes Unique identifier of the report 
AccountId
 string Yes Unique identifier of the account

Request

GET /api/v1/instantbankanalysis/BankingTransactions/b0ef740d-ddff-4b98-919e-6f9c6ae4753f/6442951
Authorization: Bearer <accessToken>
Content-Type: application/json

Response Parameters

The following are the response parameters for GET /api/v1/instantbankanalysis/BankingTransactions/{ReportId}/{AccountId}:

200 OK
Table 86. Top-level fields:
Field Data Type Description Example 
data
 array List of banking transactions for the given account [{...}] 
totalCount
 int Total number of transactions available 163 
pageNumber
 int Current page number 1 
pageSize
 int Number of transactions returned per page 10
Table 87. data[] object (transaction details)
Field Data Type Description 
id
 string Transaction record ID (GUID) 
accountSummaryId
 string Account summary ID (GUID) 
merchantId
 string Merchant/tenant identifier 
requestUniqueId
 string Report request unique ID (GUID) 
accountId
 number Account identifier 
transactionId
 number Transaction identifier from source system 
transactionType
 string Type of transaction (Credit or Debit) 
postedDate
 string Transaction posted date (ISO-8601) 
createdOnDate
 string Record creation date (ISO-8601) 
amount
 number Transaction amount (positive for credit, negative for debit) 
currencyCode
 string Transaction currency (ISO 4217 code) 
memo
 string Transaction description/memo 
category
 string Category of transaction 
subCategory
 string Sub-category of transaction 
isActive
 boolean Indicates whether the transaction is active 
createdDate
 string Record created date (ISO-8601) 
createdBy
 string Creator of the record 
updatedBy
 string | null Last updater if available 
updatedDate
 string | null Last updated timestamp (ISO-8601) or null 
deletedDate
 string | null Deletion timestamp (ISO-8601) or null

Response

{ 

"data": [ 

{ 

"id": "8db37daa-6be6-42d3-aba1-998f85e7d9ca", 

"accountSummaryId": "5c87a8b5-09d7-4bf2-afa1-5d5245c518e4", 

"merchantId": "GLO51671", 

"requestUniqueId": "b0ef740d-ddff-4b98-919e-6f9c6ae4753f", 

"accountId": 6442951, 

"transactionId": 32828233, 

"transactionType": "Debit", 

"postedDate": "2025-07-03T00:00:00.0000000Z", 

"createdOnDate": "2025-08-13T07:25:04.0000000Z", 

"amount": -300, 

"currencyCode": "USD", 

"memo": "ALLY BANK DES:SAVINGS TRANSFER", 

"category": "Fees", 

"subCategory": "Uncategorized", 

"isActive": true, 

"createdDate": "2025-08-13T07:26:01.4424326Z", 

"createdBy": "System", 

"updatedBy": null, 

"updatedDate": null, 

"deletedDate": null 

} 

], 

"totalCount": 163, 

"pageNumber": 1, 

"pageSize": 10 

}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request for GET /api/v1/instantbankanalysis/BankingTransactions/{ReportId}/{AccountId}:
Table 88. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Error summary 
data
 null Always null 
errors
 array Error details

400 Bad Request


{ 
	  "success": false, 
	  "message": "Report not found.", 
	  "data": null, 
	  "errors": [ 
  		"Report not found." 
  	  ] 
}

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error for GET /api/v1/instantbankanalysis/BankingTransactions/{ReportId}/{AccountId}:
Table 89. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Server error message 
data
 null Always null 
errors
 array Diagnostic/help message

500 Internal Server Error 


{ 
 	"success": false, 
	"message": "Something went wrong!", 
	"data": null, 
	"errors": [ 
		"Please contact administrator." 
	] 
}

17. Add a New User in the Application

Using this API, you can create a new user account in the application.

Request Parameters

The following are the request parameters for POST /api/v1/user:
Field Data Type Required Description
Authorization string Yes Bearer token obtained from login
Content-Type string Yes Media type of the request body
Table 90. Body
Field Data Type Required Description 
firstName
 string Yes User’s first name 
lastName
 string Yes User’s last name 
jobTitle
 string No User’s job title 
email
 string Yes User’s email address 
phone
 string Yes Primary phone number 
secondaryPhone
 string No Secondary phone number 
secondaryEmail
 string No Secondary email address 
password
 string Yes Account password 
isActive
 boolean Yes Whether the account is active

Request


{ 
  "firstName": "VxsdoaAlTEpjgAGTbyuO", 
  "lastName": "JzOjQkjKLedloTSF", 
  "jobTitle": "string", 
  "email": "user@example.com", 
  "phone": "9251990831", 
  "secondaryPhone": "string", 
  "secondaryEmail": "string", 
  "password": "4z~`T4~JnX_^%2D90{>6j@s", 
  "isActive": true 
}

Response Parameters

The following are the response parameters for POST /api/v1/user:

200 OK
Table 91. Top-level fields:
Field Data Type Description 
success
 boolean Operation status 
message
 string Outcome message 
data
 object Newly created user record 
errors
 null Null on success
Table 92. data object
Field Data Type Description 
id
 string User ID (GUID) 
firstName
 string First name 
lastName
 string Last name 
jobTitle
 string Job title 
email
 string Primary email 
phone
 string Primary phone 
secondaryPhone
 string Secondary phone 
secondaryEmail
 string Secondary email 
password
 string Password (masked/placeholder) 
isActive
 boolean Active status

Response


{ 
  "success": true, 
  "message": "User created successfully", 
  "data": { 
    "id": "3c6f4aff-90f4-4945-88c2-bd9c51168e76", 
    "firstName": "John", 
    "lastName": "Doe", 
    "jobTitle": "Software Engineer", 
    "email": "john.doe@example.com", 
    "phone": "9876543210", 
    "secondaryPhone": "1234567890", 
    "secondaryEmail": "john.alt@example.com", 
    "password": "*****", 
    "isActive": true 
  }, 
  "errors": null 
}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request for POST /api/v1/user:
Table 93. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Error summary 
data
 null Always null 
errors
 array Validation or conflict messages

400 Bad Request


{ 
  "success": false, 
  "message": "User with this email already exists", 
  "data": null, 
  "errors": [ 
    "Email is already in use." 
  ] 
}

Query Parameters: 401 Unauthorized

The following are the query parameters for 401 Unauthorized Request for POST /api/v1/user:
Table 94. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Authorization/permission message 
data
 null Always null 
errors
 array Additional info for client/support

401 Unauthorized


{ 
  "success": false, 
  "message": "Access Denied", 
  "data": null, 
  "errors": [ 
    "Your request cannot be processed. If you believe this is an error, please contact support." 
  ] 
}

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error for POST /api/v1/user:
Table 95. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Server error message 
data
 null Always null 
errors
 array Diagnostic/help message

500 Internal Server Error 


{ 
  "success": false, 
  "message": "Something went wrong!", 
  "data": null, 
  "errors": [ 
    "Please contact administrator." 
  ] 
}

18. Find a User by ID

You can use this API to fetch details of a user using their unique user ID.

Request Parameters

The following are the request parameters for GET /api/v1/user/{userId}:
Table 96. Headers
Field Data Type Required Description
Authorization string Yes Bearer token obtained from login
Content-Type string Yes Media type of request
Table 97. Path Parameters
Field Data Type Required Description 
userId
 string Yes Unique identifier of user

Request

GET /api/v1/user/ab6e9b78-1737-4cba-bfbf-0ce1852d2049
Authorization: Bearer <accessToken>
Content-Type: application/json

Response Parameters

The following are the response parameters for GET /api/v1/user/{userId}:

200 OK
Table 98. Top-level fields:
Field Data Type Description 
success
 boolean Operation status 
message
 string Outcome message 
data
 object Retrieved user record 
errors
 null Null on success
Table 99. data object
Field Data Type Description 
updatedDate
 string Last updated timestamp (ISO-8601) 
id
 string User ID (GUID) 
firstName
 string First name 
lastName
 string Last name 
jobTitle
 string Job title 
phone
 string Primary phone number 
email
 string Primary email address 
secondaryPhone
 string Secondary phone number 
secondaryEmail
 string Secondary email address 
createdDate
 string Record creation date (ISO-8601) 
isActive
 boolean Active status

Response


{ 
  "success": true, 
  "message": "User retrieved successfully", 
  "data": { 
    "updatedDate": "2025-08-18T01:19:16.3724142Z", 
    "id": "ab6e9b78-1737-4cba-bfbf-0ce1852d2049", 
    "firstName": "John", 
    "lastName": "Doe", 
    "jobTitle": "Software Engineer", 
    "phone": "1234567890", 
    "email": "john.doe@example.com", 
    "secondaryPhone": "9876543210", 
    "secondaryEmail": "john.secondary@example.com", 
    "createdDate": "2025-05-18T01:19:16.3724064Z", 
    "isActive": true 
  }, 
  "errors": null 
}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request for GET /api/v1/user/{userId}:
Table 100. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Error summary 
data
 null Always null 
errors
 array Validation or lookup errors

400 Bad Request


{ 
  "success": false, 
  "message": "Not found", 
  "data": null, 
  "errors": [ 
    "User not found." 
  ] 
}

Query Parameters: 401 Unauthorized

The following are the query parameters for 401 Unauthorized Request for GET /api/v1/user/{userId}:
Table 101. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Authorization failure message 
data
 null Always null 
errors
 array Error/help messages

401 Unauthorized


{ 
  "success": false, 
  "message": "Access Denied", 
  "data": null, 
  "errors": [ 
    "Your request cannot be processed. If you believe this is an error, please contact support." 
  ] 
}

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error for GET /api/v1/user/{userId}:
Table 102. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Server error message 
data
 null Always null 
errors
 array Diagnostic/help message

500 Internal Server Error 


{ 
  "success": false, 
  "message": "Something went wrong!", 
  "data": null, 
  "errors": [ 
    "Please contact administrator." 
  ] 
}

19. View All Users

This API enables you to retrieve a list of all users in the system.

Request Parameters

The following are the request parameters for GET /api/v1/user/all:
Table 103. Headers
Field Data Type Required Description
Authorization string Yes Bearer token obtained from login
Content-Type string Yes Media type of request
Table 104. Query Parameters
Field Data Type Required Default Description 
nameQuery
 string No — General search term for user name/email lookup 
isActive
 bool No — Filter users by active status (true/false) 
pageNumber
 int No 1 Page number for paginated results (must be > 0) 
pageSize
 int No 10 Number of items per page (1–100) 
orderBy
 string No CreatedDate Field to sort the records 
order
 string No DESC Sort direction (ASC or DESC)

Request

GET /api/v1/user/all?pageNumber=1&pageSize=10&isActive=true&orderBy=CreatedDate&order=DESC
Authorization: Bearer <accessToken>
Content-Type: application/json

Response Parameters

The following are the response parameters for GET /api/v1/user/all:

200 OK
Table 105. Top-level fields:
Field Data Type Description 
success
 boolean Indicates if the request was successful 
message
 string Response message 
data
 object Paginated user list 
errors
 null Null on success
Table 106. data object
Field Data Type Description 
pageNumber
 int Current page number 
pageSize
 int Number of records per page 
totalRecords
 int Total number of users available 
records
 array Array of user records
Table 107. records[] object (user details)
Field Data Type Description 
id
 string User ID (GUID) 
firstName
 string User’s first name 
lastName
 string User’s last name 
jobTitle
 string Job title 
phone
 string Primary phone number 
email
 string Primary email address 
secondaryPhone
 string Secondary phone number 
secondaryEmail
 string Secondary email address 
createdDate
 string Account creation date (ISO-8601) 
isActive
 boolean Active status

Response


{ 
  "success": true, 
  "message": "Request successful", 
  "data": { 
    "pageNumber": 1, 
    "pageSize": 10, 
    "totalRecords": 25, 
    "records": [ 
      { 
        "id": "46a8ee59-de75-4005-a516-e2c3be7b6ed4", 
        "firstName": "John", 
        "lastName": "Doe", 
        "jobTitle": "Software Engineer", 
        "phone": "1234567890", 
        "email": "john.doe@example.com", 
        "secondaryPhone": "1234567890", 
        "secondaryEmail": "john.alt@example.com", 
        "createdDate": "2025-06-18T01:19:16.3899655Z", 
        "isActive": true 
      } 
    ] 
  }, 
  "errors": null 
}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request for GET /api/v1/user/all:
Table 108. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Error summary 
data
 null Always null 
errors
 array Validation or request errors

400 Bad Request


{ 
  "success": false, 
  "message": "Bad Request", 
  "data": null, 
  "errors": [ 
    "Invalid request parameters.", 
    "PageNumber must be greater than 0." 
  ] 
}

Query Parameters: 401 Unauthorized

The following are the query parameters for 401 Unauthorized Request for GET /api/v1/user/all:
Table 109. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Authorization failure message 
data
 null Always null 
errors
 array Error/help messages

401 Unauthorized


{ 
  "success": false, 
  "message": "Access Denied", 
  "data": null, 
  "errors": [ 
    "Your request cannot be processed. If you believe this is an error, please contact support." 
  ] 
}

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error for GET /api/v1/user/all:
Table 110. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Server error message 
data
 null Always null 
errors
 array Diagnostic/help message

500 Internal Server Error 


{ 
  "success": false, 
  "message": "Bad Request", 
  "data": null, 
  "errors": [ 
    "Invalid request parameters.", 
    "PageNumber must be greater than 0." 
  ] 
}

20. Update User Information

This API enables you to update the profile and account details of an existing user.

Request Parameters

The following are the request parameters for PUT /api/v1/user:
Table 111. Headers
Field Data Type Required Description
Authorization string Yes Bearer token obtained from login
Content-Type string Yes Media type of the request body
Table 112. Body
Field Data Type Required Description 
id
 string Yes User ID (GUID) 
firstName
 string Yes User’s first name 
lastName
 string Yes User’s last name 
jobTitle
 string No Job title 
phone
 string Yes Primary phone number 
email
 string Yes Primary email address 
secondaryPhone
 string No Secondary phone number 
secondaryEmail
 string No Secondary email address 
isActive
 boolean Yes Whether the account is active

Request


{ 
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 
  "firstName": "string", 
  "lastName": "string", 
  "jobTitle": "string", 
  "phone": "4920800449", 
  "email": "user@example.com", 
  "secondaryPhone": "string", 
  "secondaryEmail": "string", 
  "isActive": true 
}

Response Parameters

The following are the response parameters for PUT /api/v1/user:

200 OK
Table 113. Top-level fields:
Field Data Type Description 
success
 boolean Operation status 
message
 string Outcome message 
data
 object Updated user record 
errors
 null Null on success
Table 114. data object
Field Data Type Description 
updatedDate
 string Last updated timestamp (ISO-8601) 
id
 string User ID (GUID) 
firstName
 string First name 
lastName
 string Last name 
jobTitle
 string Job title 
email
 string Primary email 
phone
 string Primary phone 
secondaryPhone
 string Secondary phone 
secondaryEmail
 string Secondary email 
password
 string Masked placeholder 
isActive
 boolean Active status

Response


{ 
  "success": true, 
  "message": "User updated successfully", 
  "data": { 
    "updatedDate": "2025-08-18T01:19:16.2920045Z", 
    "id": "a9213e51-c9ca-467d-8839-f55627ca1bee", 
    "firstName": "John", 
    "lastName": "Doe", 
    "jobTitle": "Software Engineer", 
    "email": "john.doe@example.com", 
    "phone": "9876543210", 
    "secondaryPhone": "1234567890", 
    "secondaryEmail": "john.alt@example.com", 
    "password": "*****", 
    "isActive": true 
  }, 
  "errors": null 
}

Query Parameters: 400 Bad Request

The following are the query parameters for 400 Bad Request for PUT /api/v1/user:
Table 115. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Error summary 
data
 null Always null 
errors
 array Validation/conflict messages

400 Bad Request


{ 
  "success": false, 
  "message": "User with this email already exists", 
  "data": null, 
  "errors": [ 
    "Email is already in use." 
  ] 
}

Query Parameters: 401 Unauthorized

The following are the query parameters for 401 Unauthorized Request for PUT /api/v1/user:
Table 116. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Authorization failure message 
data
 null Always null 
errors
 array Additional guidance for client/support

401 Unauthorized


{ 
  "success": false, 
  "message": "Access Denied", 
  "data": null, 
  "errors": [ 
    "Your request cannot be processed. If you believe this is an error, please contact support." 
  ] 
}

Query Parameters: 500 Internal Server Error

The following are the query parameters for 500 Internal Server Error for PUT /api/v1/user:
Table 117. Top-level fields:
Field Data Type Description 
success
 boolean Always false 
message
 string Server error message 
data
 null Always null 
errors
 array Diagnostic/help message

500 Internal Server Error 


{ 
  "success": false, 
  "message": "Something went wrong!", 
  "data": null, 
  "errors": [ 
    "Please contact administrator." 
  ] 
}