Instant onboarding

​

Process breakdown

​

1. Onboarding API calls

• Authentication:
  Upon accepting initial invitation or signing in, the customer receives the following tokens:
  • access token: used for purposes like logout, update password etc.
  • id token: used for secure api communication. (recommended for all api calls.)
  • refresh token: to renew Access and ID token.
  Note: always use the id token for secure api communication. see this page for more info.
• Submit business data:
  The customer provides business information in the following structure:
  Copy

  Ask AI

  {
    "name": "string",
    "tin": "string",
    "external_id": "uuid",
    "address_line_1": "string",
    "address_postal_code": "string",
    "address_city": "string",
    "address_state": "string",
    "address_country": "string",
    "official_website": "string (optional)",
    "owners": "array (optional)"
  }
  

  This triggers the system to perform multiple onboarding tasks. See Add Business documentation for further information.

​

2. Worth AI System Actions

• Business Search:
  Identifies and verifies the business in the system.
• Business Verification:
  Validates business details such as legal standing and ownership information.
• Fetching Public Records:
  Retrieves relevant public records associated with the business.
• Fetching Website Metadata:
  Gathers metadata from the business’s official website if provided.
• Owners’ Identity Verification:
  Verifies the identity of the business owners based on the provided data.
• Business Scoring:
  Calculates the business score, evaluating creditworthiness and other key metrics.

​

3. Retrieve Data

• Fetch business data:
  Retrieves detailed information about a specific business 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}

​

4. Update Business Data

• Update business data:
  Update business details via PATCH requests.
  API Endpoint: /add-or-update-business/update-business