Integtation events

integration.connected | integration.disconnected | integration.failed

Integration

Integation - Sample Payload

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

Hello and welcome to Worth API! 
Here at Worth we want to ensure a seamless onboarding experience and have created this guide for you and your businesses. 
This guide will show you how to get started using the Worth API documentation. 
Should you have any questions please feel free to reach out to a Worth team member to better assist you. 
Thanks!

Overview

The following steps are intended to help you add a business to the customer portal.  This step is needed in order to generate a business ID. This business ID will be used to make other API calls such as KYB and KYC as it serves as the unique identifier of each business that is onboarded.

Add Business

KYB/KYC

When the [GET Banking Info](https://docs.worthai.com/api-reference/integration/banking/banking-information) call is made, two background processes are triggered: **verification** and **authentication**. These work together to confirm that a bank account is real, active, and that the person or business submitting it is authorized to use it.
In order to properly verify and validate banking information, a specific set of data is **_required_** to return the appropriate verifications and validations. This information is captured in the [POST Add Business](https://docs.worthai.com/api-reference/add-or-update-business/add-business) endpoint.
The following data validations will highlight what information is **required** to validate and authenticate banking information.

Banking

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

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 an existing business record based on the provided details.

Update Business

Invite applicants to be added to an existing Business.

Send Business Invite

Retrieve details about cases associated with a particular customerID and businessID.

Get Business Cases

Retrieve details for a particular business associated with the businessID provided

Get Business By ID

Retrieve all cases associated with a particular customerID.

Get Customer Cases

Retrieve details about a particular case associated with the given customerID and caseID.

Get Customer Case By ID

Retrieve the Worth score and detailed score breakdown for the specified business entity.

Get Business Score

Retrieve banking information for a particular business.

Banking Information

Retrieve reports (balance sheet, income statement, or cash flow) associated with a particular business_id.

Get Reports

Retrieve annualized tax data associated with a particular businessID

Tax Filing

Retrieve public records associated with a particular businessID

Public Records

Retrieves detailed verification results for a business, including submitted values, matched sources, and confidence levels.

Get Verification Details

Fetch enriched business website data, including domain details, SSL status, and associated metadata.

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. For more details on using these endpoints, please reference the [Getting Started](https://docs.worthai.com/getting-started/overview) guide.

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. For more details on using these endpoints, please reference the [Getting Started](https://docs.worthai.com/getting-started/overview) guide.

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.

About Webhooks

Business

Business - Sample Payload

Score

Score - Sample Payload

Case

Case - Sample Payload

Onboarding

Onboarding - Sample Payload

Risk

Risk - Sample Payload

To reduce manual data entry and speed up onboarding, clients can use our **KYB** (Know Your Business) and **KYC** (Know Your Customer) endpoints to pre-fill relevant business and ownership details directly into their form or platform. This helps streamline the review process, improves accuracy, and enhances the user experience.

Event	Description
`integration.connected`	Triggered when an integration is connected for a business.
`integration.disconnected`	Triggered when an integration is disconnected for a business.
`integration.failed`	Triggered when an integration fails for a business

Webhooks (Beta)

Sample Payloads

Integation - Sample Payload

Integtation events

integration.connected | integration.disconnected | integration.failed

Webhooks (Beta)

Sample Payloads

​Integtation events

​integration.connected | integration.disconnected | integration.failed

Integtation events

integration.connected | integration.disconnected | integration.failed