Get Verification Details

curl --request GET \
  --url https://api.joinworth.com/integration/api/v1/verification/businesses/{businessID}/business-entity \
  --header 'Authorization: Bearer <token>'

{
  "status": "<string>",
  "message": "<string>",
  "data": {
    "businessEntityVerification": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-12-25",
      "updated_at": "2023-12-25",
      "business_integration_task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "<string>",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": "in_review",
      "tin": "<string>",
      "formation_state": "<string>",
      "formation_date": "2023-12-25",
      "year": 123,
      "number_of_employees": 123
    },
    "reviewTasks": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "business_entity_verification_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-12-25",
        "updated_at": "2023-12-25",
        "category": "sos",
        "key": "<string>",
        "status": "pending",
        "message": "<string>",
        "label": "<string>",
        "sublabel": "<string>",
        "metadata": [
          {
            "id": "ac01034d-325e-455b-bc3d-c1852c6bb306",
            "type": "name",
            "metadata": {
              "name": "banking test 1",
              "submitted": true
            }
          }
        ]
      }
    ],
    "registrations": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "business_entity_verification_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-12-25",
        "updated_at": "2023-12-25",
        "external_id": "<string>",
        "name": "<string>",
        "status": "active",
        "sub_status": "<string>",
        "status_details": "<string>",
        "jurisdiction": "<string>",
        "entity_type": "<string>",
        "file_number": "<string>",
        "full_addresses": [
          "<string>"
        ],
        "registration_date": "2023-12-25",
        "registration_state": "<string>",
        "source": "<string>"
      }
    ],
    "addressSources": [
      {
        "id": "<string>",
        "business_entity_verification_id": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "external_id": "<string>",
        "external_registration_id": "<string>",
        "full_address": "<string>",
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "lat": 123,
        "long": 123,
        "submitted": true,
        "deliverable": true,
        "cmra": true,
        "address_property_type": "<string>"
      }
    ],
    "people": [
      "<string>"
    ],
    "names": [
      {
        "id": "<string>",
        "business_entity_verification_id": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "name": "<string>",
        "type": "<string>",
        "submitted": true,
        "source": [
          {
            "id": "<string>",
            "type": "<string>",
            "metadata": {
              "state": "<string>",
              "status": "<string>",
              "file_number": "<string>",
              "jurisdiction": "<string>"
            }
          }
        ]
      }
    ]
  }
}

GET

verification

businesses

{businessID}

business-entity

Get Verification Details

curl --request GET \
  --url https://api.joinworth.com/integration/api/v1/verification/businesses/{businessID}/business-entity \
  --header 'Authorization: Bearer <token>'

{
  "status": "<string>",
  "message": "<string>",
  "data": {
    "businessEntityVerification": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-12-25",
      "updated_at": "2023-12-25",
      "business_integration_task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "<string>",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": "in_review",
      "tin": "<string>",
      "formation_state": "<string>",
      "formation_date": "2023-12-25",
      "year": 123,
      "number_of_employees": 123
    },
    "reviewTasks": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "business_entity_verification_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-12-25",
        "updated_at": "2023-12-25",
        "category": "sos",
        "key": "<string>",
        "status": "pending",
        "message": "<string>",
        "label": "<string>",
        "sublabel": "<string>",
        "metadata": [
          {
            "id": "ac01034d-325e-455b-bc3d-c1852c6bb306",
            "type": "name",
            "metadata": {
              "name": "banking test 1",
              "submitted": true
            }
          }
        ]
      }
    ],
    "registrations": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "business_entity_verification_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-12-25",
        "updated_at": "2023-12-25",
        "external_id": "<string>",
        "name": "<string>",
        "status": "active",
        "sub_status": "<string>",
        "status_details": "<string>",
        "jurisdiction": "<string>",
        "entity_type": "<string>",
        "file_number": "<string>",
        "full_addresses": [
          "<string>"
        ],
        "registration_date": "2023-12-25",
        "registration_state": "<string>",
        "source": "<string>"
      }
    ],
    "addressSources": [
      {
        "id": "<string>",
        "business_entity_verification_id": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "external_id": "<string>",
        "external_registration_id": "<string>",
        "full_address": "<string>",
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "lat": 123,
        "long": 123,
        "submitted": true,
        "deliverable": true,
        "cmra": true,
        "address_property_type": "<string>"
      }
    ],
    "people": [
      "<string>"
    ],
    "names": [
      {
        "id": "<string>",
        "business_entity_verification_id": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "name": "<string>",
        "type": "<string>",
        "submitted": true,
        "source": [
          {
            "id": "<string>",
            "type": "<string>",
            "metadata": {
              "state": "<string>",
              "status": "<string>",
              "file_number": "<string>",
              "jurisdiction": "<string>"
            }
          }
        ]
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

businessID

string

required

Response

status

string

message

string

data

Data54 · object

Show child attributes

data.businessEntityVerification

BusinessEntityVerification · object

Show child attributes

data.businessEntityVerification.id

string<uuid>

Unique identifier for the business entity verification record.

data.businessEntityVerification.created_at

string<date>

The date when the verification record was created.

data.businessEntityVerification.updated_at

string<date> | null

The date when the verification record was last updated, or null if never updated.

data.businessEntityVerification.business_integration_task_id

string<uuid>

The integration task identifier associated with this verification process.

data.businessEntityVerification.external_id

string

Client-provided external identifier for tracking the business.

data.businessEntityVerification.business_id

string<uuid>

Unique identifier for the business in the system.

data.businessEntityVerification.name

string | null

The legal name of the business, if available.

data.businessEntityVerification.status

enum<string>

Current verification status: • in_review: The business is under review. • approved: Business details have been verified successfully. • rejected: Business details failed verification.

Available options:

in_review,

rejected,

approved

data.businessEntityVerification.tin

string | null

Tax Identification Number (TIN) for the business, if provided.

data.businessEntityVerification.formation_state

string | null

State where the business was legally formed, if known.

data.businessEntityVerification.formation_date

string<date> | null

The date when the business was legally formed, if known.

data.businessEntityVerification.year

integer | null

The year the business was created, if known.

data.businessEntityVerification.number_of_employees

integer | null

Number of employees at the time of verification, if known.

data.reviewTasks

ReviewTask · object[]

Show child attributes

data.reviewTasks.id

string<uuid>

Unique identifier for this verification task.

data.reviewTasks.business_entity_verification_id

string<uuid>

Identifier of the parent business entity verification record.

data.reviewTasks.created_at

string<date>

Date when this verification task was created.

data.reviewTasks.updated_at

string<date> | null

Date when this verification task was last updated, or null if not updated.

data.reviewTasks.category

enum<string>

Type of verification performed: • sos: source-of-service check • address: address validation • tin: Tax ID number verification • watchlist: watchlist/sanctions screening • name: business name matching

Available options:

sos,

address,

tin,

watchlist,

name

data.reviewTasks.key

string

Unique key or code identifying the specific sub-task or data field.

data.reviewTasks.status

enum<string>

Current task status: • pending: Task is in progress • success: Task completed successfully • failure: Task completed with an error

Available options:

pending,

success,

failure

data.reviewTasks.message

string | null

Optional human-readable message or error detail returned by the task.

data.reviewTasks.label

string

data.reviewTasks.sublabel

string

data.reviewTasks.metadata

(Metadata2 · object | string)[]

Show child attributes

data.reviewTasks.metadata.id

string

data.reviewTasks.metadata.type

string

data.reviewTasks.metadata.metadata

Metadata3 · object

Show child attributes

data.reviewTasks.metadata.metadata.name

string

data.reviewTasks.metadata.metadata.submitted

boolean

data.reviewTasks.metadata.metadata.city

string

data.reviewTasks.metadata.metadata.state

string

data.reviewTasks.metadata.metadata.postal_code

string

data.reviewTasks.metadata.metadata.full_address

string

data.reviewTasks.metadata.metadata.address_line1

string

data.reviewTasks.metadata.metadata.address_line2

string | null

Example:

{
  "id": "ac01034d-325e-455b-bc3d-c1852c6bb306",
  "type": "name",
  "metadata": {
    "name": "banking test 1",
    "submitted": true
  }
}

data.registrations

Registration · object[]

Show child attributes

data.registrations.id

string<uuid>

data.registrations.business_entity_verification_id

string<uuid>

data.registrations.created_at

string<date>

data.registrations.updated_at

string<date> | null

data.registrations.external_id

string

data.registrations.name

string

data.registrations.status

enum<string>

Current registration status: • active: the business is currently registered and in good standing. • inactive: the business registration is inactive or expired.

Available options:

active,

inactive

data.registrations.sub_status

string | null

data.registrations.status_details

string | null

data.registrations.jurisdiction

string

data.registrations.entity_type

string

data.registrations.file_number

string

data.registrations.full_addresses

string[]

data.registrations.registration_date

string<date>

data.registrations.registration_state

string

data.registrations.source

string

data.addressSources

AddressSource · object[]

Show child attributes

data.addressSources.id

string

data.addressSources.business_entity_verification_id

string

data.addressSources.created_at

string

data.addressSources.updated_at

string | null

data.addressSources.external_id

string

data.addressSources.external_registration_id

string

data.addressSources.full_address

string

data.addressSources.address_line_1

string

data.addressSources.address_line_2

string | null

data.addressSources.city

string

data.addressSources.state

string

data.addressSources.postal_code

string

data.addressSources.lat

data.addressSources.long

data.addressSources.submitted

boolean

data.addressSources.deliverable

boolean

data.addressSources.cmra

boolean

data.addressSources.address_property_type

string | null

data.people

string[]

data.names

Name1 · object[]

Show child attributes

data.names.id

string

data.names.business_entity_verification_id

string

data.names.created_at

string

data.names.updated_at

string | null

data.names.name

string

data.names.type

string

data.names.submitted

boolean

data.names.source

Source · object[]

Show child attributes

data.names.source.id

string

data.names.source.type

string

data.names.source.metadata

Metadata1 · object

Show child attributes

data.names.source.metadata.state

string

data.names.source.metadata.status

string

data.names.source.metadata.file_number

string

data.names.source.metadata.jurisdiction

string

Public Records Get Website Data

⌘I

Sign In

Forgot Password

Customers

Customer Users

Business

Cases

Business Details

Worth 360 Report

NPI

Custom Fields

Get Verification Details

Authorizations

Path Parameters

Response