# Worth

- [Introduction](https://docs.worthai.com/introduction.md): 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.
- [Overview](https://docs.worthai.com/getting-started/overview.md): 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…
- [Add Business](https://docs.worthai.com/getting-started/add-business.md): 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.
- [KYB/KYC](https://docs.worthai.com/getting-started/kyb-kyc.md)
- [Banking](https://docs.worthai.com/getting-started/banking.md): 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 busine…
- [Customer Sign In](https://docs.worthai.com/api-reference/auth/sign-in/customer-sign-in.md): This endpoint allows customers to sign in with their email and password.
- [Customer Refresh Token](https://docs.worthai.com/api-reference/auth/sign-in/customer-refresh-token.md): Refreshes the customer's authentication token to maintain session validity.
- [Customer Logout](https://docs.worthai.com/api-reference/auth/sign-in/customer-logout.md): Logs out a customer user by invalidating their session or token.
- [Forgot Password Init](https://docs.worthai.com/api-reference/auth/sign-in/forgot-password-init.md): Allows an admin to request a password reset link via email.
- [Reset Password](https://docs.worthai.com/api-reference/auth/sign-in/reset-password.md): Allows a user to reset their password using a valid reset token.
- [Accept Invitation](https://docs.worthai.com/api-reference/auth/users/accept-invitation.md): Allows a user to accept an invitation using an invite token.
- [Get Customer Subroles](https://docs.worthai.com/api-reference/auth/customers/get-customer-subroles.md): Fetches a list of subroles associated with a specific customer. Accessible by respective Customer.
- [Get Customer Users](https://docs.worthai.com/api-reference/auth/customers/get-customer-users.md): Fetches a list of users associated with a specific customer. Accessible by respective Customer.
- [Create Customer User](https://docs.worthai.com/api-reference/auth/customers/create-customer-user.md): Allows Customer to create a new user under a specific customer.
- [Get Customer User By ID](https://docs.worthai.com/api-reference/auth/customers/get-customer-user-by-id.md): Fetch details of a specific user associated with a customer.
- [Update Customer User By ID](https://docs.worthai.com/api-reference/auth/customers/update-customer-user-by-id.md): Update user details for a specific customer.
- [Customer User Resend Invitation](https://docs.worthai.com/api-reference/auth/customers/customer-user-resend-invitation.md): Allows customer with proper permissions to resend an invite to a specific user associated with a customer.
- [Add Business](https://docs.worthai.com/api-reference/add-or-update-business/add-business.md): Create a single business record based on the provided details.
- [Update Business](https://docs.worthai.com/api-reference/add-or-update-business/update-business.md): Update an existing business record based on the provided details. One of businessID or external_id MUST be provided to identify a business to update.
- [Send Business Invite](https://docs.worthai.com/api-reference/case/invites/send-business-invite.md): Send an invitation to onboard a business and its applicants. You can either create a new business with the invite or reference an existing business. At least one applicant must be provided via the `applicants` array. Applicant email addresses must not use disposable email domains.
- [Get Customer Businesses](https://docs.worthai.com/api-reference/case/businesses/get-customer-businesses.md): Get all businesses associated with a particular customerID.
- [Get Business Cases](https://docs.worthai.com/api-reference/case/businesses/get-business-cases.md): Retrieve details about cases associated with a particular customerID and businessID.
- [Get Related Businesses](https://docs.worthai.com/api-reference/case/related-businesses/get-related-businesses.md): Retrieves a list of businesses related to the one specified by the given businessID.
- [Get Business By ID](https://docs.worthai.com/api-reference/case/businesses/get-business-details.md): Retrieve details for a particular business associated with the businessID provided
- [Get Customer Cases](https://docs.worthai.com/api-reference/case/cases/get-customer-cases.md): Retrieve all cases associated with a particular customerID.
- [Get Customer Case By ID](https://docs.worthai.com/api-reference/case/cases/get-customer-case-by-id.md): Retrieve details about a particular case associated with the given customerID and caseID.
- [Update case status](https://docs.worthai.com/api-reference/case/cases/update-assign-case.md): Updates the status of a case (and optionally the assignee). Only certain status transitions are allowed depending on the case’s current status.
- [Get Business Score](https://docs.worthai.com/api-reference/score/score/get-business-score.md): Retrieve the Worth score and detailed score breakdown for the specified business entity.
- [Banking Information Details](https://docs.worthai.com/api-reference/integration/banking/banking-information-details.md): Retrieve banking information for a particular business.
- [Get Reports](https://docs.worthai.com/api-reference/integration/accounting/get-reports.md): Retrieve reports (balance sheet, income statement, or cash flow) associated with a particular business_id.
- [Tax Filing](https://docs.worthai.com/api-reference/integration/taxation/tax-filing.md): Retrieve annualized tax data associated with a particular businessID
- [Public Records](https://docs.worthai.com/api-reference/integration/public-records/public-records.md): Retrieve public records associated with a particular businessID
- [Get Verification Details](https://docs.worthai.com/api-reference/integration/verification/get-verification-details.md): Retrieves detailed verification results for a business, including submitted values, matched sources, and confidence levels.
- [Get Website Data](https://docs.worthai.com/api-reference/integration/verification/get-business-website-data.md): Fetch enriched business website data, including domain details, SSL status, and associated metadata.
- [KYB](https://docs.worthai.com/api-reference/integration/facts/kyb.md): Retrieves comprehensive 'Know Your Business' verification details for a given business identifier, including legal, formation, ownership, address, and match data from multiple sources.
- [Reviews](https://docs.worthai.com/api-reference/integration/facts/reviews.md): Retrieves 'Business Reviews' for a given business identifier from multiple sources across several review platforms.
- [Bankruptcies Judgements & Liens (BJL)](https://docs.worthai.com/api-reference/integration/facts/bankruptcies-judgements-&-liens-bjl.md): Retrieve bankruptcies, judgements, and liens associated with a business
- [KYC Ownership Verification](https://docs.worthai.com/api-reference/integration/verification/kyc-ownership-verification.md): Know Your Customer: returns a list of individuals with ownership or control, including their submitted personal details and verification results.
- [Adverse Media](https://docs.worthai.com/api-reference/integration/public-records/adverse-media.md): Retrieve adverse media associated with a particular businessID
- [Check Worth 360 Report Generation Status](https://docs.worthai.com/api-reference/worth-360-report/check-worth-360-report-generation-status.md)
- [Generate Worth 360 Report Using Customer](https://docs.worthai.com/api-reference/worth-360-report/generate-worth-360-report-using-customer.md)
- [Get Worth 360 Report Details](https://docs.worthai.com/api-reference/worth-360-report/get-worth-360-report-details.md): ### Get Report by ID
- [Download Worth 360 Report](https://docs.worthai.com/api-reference/worth-360-report/download-worth-360-report.md)
- [Reverse NPI Lookup with POST Add Business](https://docs.worthai.com/api-reference/case/businesses/npi-reverse-lookup.md)
- [Get NPI Details](https://docs.worthai.com/api-reference/integration/verification/get-npi-details.md): Fetch NPI healthcare provider details associated with a business
- [Adding Custom Fields with POST Add Business and PATCH Update Business](https://docs.worthai.com/api-reference/case/businesses/add-update-business-custom-fields.md)
- [Get Business Custom Fields](https://docs.worthai.com/api-reference/case/businesses/get-custom-fields.md): Retrieves custom fields associated with a specified business ID. Custom fields must be enabled to utilize this endpoint. To confirm if you have custom fields enabled, please reach out to your Customer Success representative.
- [Match Pro Overview](https://docs.worthai.com/api-reference/integration/match-pro/match-pro-overview.md): Configure credentials, verify connectivity, and run Match Pro checks against businesses in your portfolio.
- [Check Match Pro Connection](https://docs.worthai.com/api-reference/integration/match-pro/check-match-pro-connection.md): Tests whether the stored Match Pro credentials are valid and reachable. Use this endpoint after saving credentials to confirm the setup is working before running match checks.
- [Get Match Pro Environment](https://docs.worthai.com/api-reference/integration/match-pro/get-match-pro-environment.md): Returns the Match Pro environment the customer tenant is currently configured for. The environment determines which payment network endpoint Match Pro checks run against.
- [Run Match Pro](https://docs.worthai.com/api-reference/integration/match-pro/run-match-pro.md): Initiates a Match Pro check for a specific business. The check runs asynchronously; this endpoint returns a task acknowledgment, not the match result.
- [Get Match Pro Result](https://docs.worthai.com/api-reference/integration/match-pro/get-match-pro-result.md): Retrieves the latest Match Pro result for a business. The response shape depends on the current state:
- [About Webhooks](https://docs.worthai.com/webhooks/webhooks.md): Use webhooks to get notified about events related to the WorthAI flow such as Business, Applicant, and Worth Score.
- [Applicant](https://docs.worthai.com/webhooks/applicant.md): Sample payloads for Applicant webhook events
- [Business](https://docs.worthai.com/webhooks/business.md): Sample payloads for Business webhook events
- [Case](https://docs.worthai.com/webhooks/case.md): Sample payloads for Case webhook events
- [Integration](https://docs.worthai.com/webhooks/integration.md): Sample payloads for Integration webhook events
- [Onboarding](https://docs.worthai.com/webhooks/onboarding.md): Sample payloads for Onboarding webhook events
- [Payment Processor](https://docs.worthai.com/webhooks/payment-processor.md): Sample payloads for Payment Processor webhook events
- [Risk](https://docs.worthai.com/webhooks/risk.md): Sample payloads for Risk webhook events
- [Worth Score](https://docs.worthai.com/webhooks/score.md): Sample payloads for Worth Score webhook events
- [Overview](https://docs.worthai.com/use-cases/onboarding/overview.md)
- [Instant onboarding](https://docs.worthai.com/use-cases/onboarding/instant-onboarding.md)
- [Invite business](https://docs.worthai.com/use-cases/onboarding/invite-business.md)
- [Overview](https://docs.worthai.com/use-cases/worth-360-report/overview.md)
- [Process diagrams](https://docs.worthai.com/use-cases/worth-360-report/process-diagrams.md)
- [Overview](https://docs.worthai.com/use-cases/pre-filling-data/overview.md): 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…
- [Step 1 - Customer Sign In](https://docs.worthai.com/use-cases/pre-filling-data/step-1-customer-sign-in.md)
- [Step 2 - Add Business](https://docs.worthai.com/use-cases/pre-filling-data/step-2-add-business.md)
- [Step 3 - KYB](https://docs.worthai.com/use-cases/pre-filling-data/step-3-kyb.md)
- [Step 4 - KYC](https://docs.worthai.com/use-cases/pre-filling-data/step-4-kyc.md)
- [Notes](https://docs.worthai.com/use-cases/pre-filling-data/step-final-notes.md)
- [Overview](https://docs.worthai.com/onboarding-sdk-3/overview.md)
- [Quick Start](https://docs.worthai.com/onboarding-sdk-3/quickstart.md): Mount your first Onboarding SDK flow in a few steps
- [API Reference](https://docs.worthai.com/onboarding-sdk-3/api-reference.md)
- [Migration Guide](https://docs.worthai.com/onboarding-sdk-3/migrate.md)
- [Sample SDK Initialization](https://docs.worthai.com/onboarding-sdk-3/sample-scenario.md)
- [API Error Handling - Send Business Invite](https://docs.worthai.com/onboarding-sdk-3/errors/send-business-invite.md)
- [API Error Handling - Sign In](https://docs.worthai.com/onboarding-sdk-3/errors/sign-in.md)
- [Overview](https://docs.worthai.com/onboarding-sdk-2/overview.md)
- [API Reference](https://docs.worthai.com/onboarding-sdk-2/api-reference.md)
- [Sample API Onboarding Flow Overview](https://docs.worthai.com/onboarding-sdk-2/api-overview.md): Complete guide to the business invitation and onboarding process
- [Sample Implementation API - Detailed Sequence Diagram](https://docs.worthai.com/onboarding-sdk-2/api-sequence-diagram.md): Complete sequence diagram showing all API interactions in the onboarding flow
- [Sample Implementation API - Step by step breakdown](https://docs.worthai.com/onboarding-sdk-2/api-step-by-step-breakdown.md): Detailed breakdown of each step in the API onboarding flow
- [API Error Handling - Add Business Service](https://docs.worthai.com/onboarding-sdk-2/errors/add-business.md): Complete guide to handling errors for the POST /businesses/customers/:customerID endpoint
- [API Error Handling - Sign In Service](https://docs.worthai.com/onboarding-sdk-2/errors/sign-in.md)

## OpenAPI Specs

- [auth](/openapi/auth.json)
- [bulk](/openapi/bulk.json)
- [business-details](/openapi/case-service/business-details.json)
- [get-patch-post-business](/openapi/case-service/get-patch-post-business.json)
- [send-business-invite](/openapi/case-service/send-business-invite.json)
- [update-assign-case](/openapi/case-service/update-assign-case.json)
- [case](/openapi/case.json)
- [adverse-media](/openapi/integration-service/adverse-media.json)
- [banking_information_details](/openapi/integration-service/banking_information_details.json)
- [get-kyb](/openapi/integration-service/get-kyb.json)
- [match-pro](/openapi/integration-service/match-pro.json)
- [personal_credit](/openapi/integration-service/personal_credit.json)
- [integration](/openapi/integration.json)
- [score](/openapi/score.json)
- [worth_360_report](/openapi/worth_360_report.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.