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

Refreshes the customer's authentication token to maintain session validity.

Customer Refresh Token

Logs out a customer user by invalidating their session or token.

Customer Logout

Allows an admin to request a password reset link via email.

Forgot Password Init

Allows a user to reset their password using a valid reset token.

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

Allows a user to accept an invitation using an invite token.

Accept Invitation

Fetches a list of subroles associated with a specific customer. Accessible by respective Customer.

Get Customer Subroles

Fetches a list of users associated with a specific customer. Accessible by respective Customer.

Get Customer Users

Allows Customer to create a new user under a specific customer.

Create Customer User

Fetch details of a specific user associated with a customer.

Get Customer User By ID

Update user details for a specific customer.

Update Customer User By ID

Allows customer with proper permissions to resend an invite to a specific user associated with a customer.

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

Retrieves comprehensive 'Know Your Business' verification details for a given business identifier, including legal, formation, ownership, address, and match data from multiple sources.

Prior to utilizing this service, one must first obtain a businessID by creating a business via the [Add business](https://docs.worthai.com/api-reference/add-or-update-business/add-business) service.

Know Your Customer: returns a list of individuals with ownership or control, including their submitted personal details and verification results.

Prior to utilizing this service, one must first obtain a businessID by creating a business via the [Add business](https://docs.worthai.com/api-reference/add-or-update-business/add-business) service.

KYC Ownership Verification

Check Worth 360 Report Generation Status

Generate Worth 360 Report Using Customer

### Get Report by ID

This endpoint retrieves a specific report based on the provided report ID.

#### Request

No request body is required for this endpoint.

- `reportID` (path parameter) - The ID of the report to be retrieved.
    

#### Response

The response will be a JSON object with the following schema:

``` json
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "report_type_id": {
          "type": "integer"
        },
        "status": {
          "type": "string"
        },
        "log": {
          "type": ["string", "null"]
        },
        "created_at": {
          "type": "string"
        },
        "created_by": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        },
        "triggered_by": {
          "type": "string"
        },
        "triggered_id": {
          "type": "string"
        },
        "report_type": {
          "type": "object",
          "properties": {
            "core_report_types": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "code": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

 ```

Get Worth 360 Report Details

Download Worth 360 Report

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

Business Onboarding Flows

Worth 360 Report Generation Flow

Process diagrams