Sign in
plaid

Create a business verification

Create a new business verification to check a business's identity and risk profile.

post/business_verification/create

Request body

client_user_idstring required

A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid products. Financial Account Matching requires this field and the /link/token/create client_user_id to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.

client_idstring

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

secretstring

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

Example request

{
  "client_user_id": "your-db-id-3b24110",
  "business": {
    "name": "Acme Corporation",
    "address": {
      "street": "123 Main St.",
      "street2": "Unit 42",
      "city": "Pawnee",
      "region": "IN",
      "postal_code": "46001",
      "country": "US"
    },
    "website": "https://example.com",
    "phone_number": "+14025671234",
    "email": "user@example.com"
  }
}

Response

OK

idstring cognito_id required

ID of the associated business verification.

client_user_idstring required

A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid products. Financial Account Matching requires this field and the /link/token/create client_user_id to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.

created_atstring date-time required

An ISO8601 formatted timestamp.

completed_atstring date-time nullable required

An ISO8601 formatted timestamp.

redacted_atstring date-time nullable required

An ISO8601 formatted timestamp.

status'active' | 'success' | 'failed' required

Status of the overall business verification

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Example response

{
  "id": "busver_52xR9LKo77r1Np",
  "client_user_id": "your-db-id-3b24110",
  "created_at": "2020-07-24T03:26:02Z",
  "completed_at": "2020-07-24T03:26:02Z",
  "redacted_at": "2020-07-24T03:26:02Z",
  "status": "success",
  "search_terms": {
    "name": "Acme Corporation",
    "address": {
      "street": "123 Main St.",
      "street2": "Unit 42",
      "city": "Pawnee",
      "region": "IN",
      "postal_code": "46001",
      "country": "US"
    },
    "website": "https://example.com",
    "phone_number": "+14025671234",
    "email_address": "user@example.com"
  },
  "kyb_check": {
    "status": "success",
    "score": 85,
    "name": {
      "summary": "match"
    },
    "address": {
      "summary": "match"
    },
    "website": {
      "summary": "match"
    },
    "match_details": {
      "name": "Acme Corporation",
      "entity_type": "llc",
      "addresses": [
        {
          "street": "123 Main St.",
          "street2": "Unit 42",
          "city": "Pawnee",
          "region": "IN",
          "postal_code": "46001",
          "country": "US",
          "is_primary": true
        }
      ],
      "phone_numbers": [
        {
          "number": "+12345678909"
        }
      ],
      "email_addresses": [
        {
          "email_address": "business@example.com"
        }
      ],
      "websites": [
        {
          "url": "https://example.com"
        }
      ],
      "formation_date": "1990-05-29"
    }
  },
  "risk_check": {
    "status": "success",
    "score": 92
  }
}

Changes