Process breakdown
1. Onboarding API calls
-
Authentication:
Upon accepting initial invitation or signing in, the customer receives the following tokens:id_token
: used for secure api communication. (required for all api calls.)refresh_token
: is used to renewid_token
.
id_token
is always required for secure api communication. See Customer Sign In page for more info. -
Invite Business:
The customer provides business information in the following structure:- Lightning Verification:
Lightning Verify instantly checks and confirms company details. It gathers information like a company’s name, address, and Taxpayer Identification Number (TIN) into a single, customizable form that applicants fill out. Upon submission, verification results are available in the Worth Case Management Platform.
Getting started: Contact your Worth Custom Success team to enable Lightning Verify.
- Lightning Verification:
2. Worth AI System Actions
Upon sending invite, an email with invite link will be sent to the applicant on the email provide. Once the applicant submitted the onboarding you can retrieve the business information using this APIs. Also you can use webhooks to get the business status and information.3. Retrieve Data
To fetch all businesses:- Fetch all business:
Retrieves all businesses information
API Endpoint:
/businesses/customers/{customerID}
-
Fetch business data:
Retrieves detailed infromation about a specific busienss by its unique ID.
API Endpoint:/businesses/{businessID}
-
Fetching Public Records:
Retrieves relevant public records found that are associated with the business.
API Endpoint:/business/{businessID}/public-records
-
Business Verification:
Retrieves business details such as legal standing and ownership information when available. API Endpoint:/verification/businesses/{businessID}/business-entity
-
Fetching Website Metadata:
Gathers metadata from the business’s official website if provided. API Endpoint:/verification/businesses/{businessID}/website-data
-
Business Scoring:
Retrieves the calculated business score.
API Endpoint:/score/businesses/{businessID}
Send invitation to business and let them onboard using Worth UI!!