Worth

Welcome to the official API documentation for Worth! This documentation serves as a comprehensive guide to help you understand and integrate with our API effectively.

Introduction

### Customer Sign-In

This endpoint allows customers to sign in with their email and password.

#### Request Body

- `email` (string, required): The email address of the customer.
- `password` (string, required): The password for the customer's account.
    

#### Response

- `status` (string): The status of the sign-in request.
- `message` (string): A message related to the sign-in status.
- `data` (object):
    - `user_details` (object):
        - `id` (string): The unique identifier of the user.
        - `first_name` (string): The first name of the user.
        - `last_name` (string): The last name of the user.
        - `email` (string): The email address of the user.
        - `is_email_verified` (boolean): Indicates whether the user's email is verified.
    - `access_token` (string): The access token for the authenticated session.
    - `id_token` (string): The ID token for the authenticated session.
    - `refresh_token` (string): The refresh token for the authenticated session.
    - `customer_details` (object):
        - `id` (string): The unique identifier of the customer.
        - `name` (string): The name of the customer.

Customer Sign In

Customer Refresh Token

Customer Logout

Forgot Password Init

Reset Password

Provide an array of business details

The service iterates through all entries in the array and returns the results of what it was able to do.

Failed items have their own section to make it clearer.

Create Businesses

Accept Invitation

Get Customer Subroles

Get Customer Users

Create Customer User

Get Customer User By ID

Update Customer User By ID

Customer User Resend Invitation

Update Business

Send Business Invite

Get Business Cases

Get Customer Case By ID

Get Business By ID

Get Customer Cases

Get Business Score

Banking Information

Get Reports

Tax Filing

Public Records

Get Verification Details

Get Website Data

KYC Ownership Verification

Use webhooks to get notified about events related to the WorthAI flow such as Business, Applicant, Score.

Sign In

Forgot Password

Bulk Imports

Customers

Customer Users

Business

Cases

Business Details

Case files download