BBB Investigation/Application for Accreditation (Leads) - Partners Only

Overview

This endpoint allows submission of organizations for BBB investigation and application for BBB accreditation.

Endpoint

EndpointHTTP MethodAuthorizationFormat of inputDescription of OperationPossible return status codes

https://api.bbb.org/api/leads/intake

POST

Required

JSON or XML, determined by header specification; JSON is default

Creates a new collection

200 OK - Successful response; does not guarantee that data will be processed correctly (i.e. may not pass validation)

400 Bad Request - Invalid input type;

could not be processed

500 - Internal error

Header Values

  • Accept (optional) - specify json (default) or xml as follows:
    • accept: application/json
    • accept: application/xml
  • Authorization
    • Requires valid Bearer token

Inbound Message

The inbound message will either be JSON or XML and consist of two section blocks: a "meta" block and a "data" block.

Meta Section Fields

FieldRequired?DescriptionType (JSON)Max LengthValid Values

EntityType

Yes

Type of entity that will be affected by this message.

String

 
  • lead

BureauCode

No

Universal code representing a regional Bureau/BBB (currently a 4-character code)

String

10

--

PartnerSourceId

Yes

Foreign Key internal id

String

256

--

SenderId

Yes

Code identifying the sending party.

String

 

Code that will be assigned by CBBB

MessageId

Yes

Sender-specified id that is unique for each message; used for tracking each inbound message

String

 

--

TransactionType

Yes

Transaction type for all entities supplied in data payload

String

 
  • create

NumberOfEntities

Yes

Number of entities that are represented in data payload

Number

 

--

CreatedTimestamp

Yes

Date created timestamp from sending party; Use Coordinated Universal Time (UTC) to standardize with Council systems;

ISO 8601 standard date/time format (http://en.wikipedia.org/wiki/ISO_8601)

String

 

ISO 8601 standard date/time format

           
Data section fields
         

Organization fields to return

Type (JSON)

Required

Description

BureauCode

string

No

Council's internal identifier of a regional BBB/Bureau

PartnerSourceId

string

Yes

Internal id of an organization.

OrganizationType

integer

Yes

Type of organization ("Business" or "Charity")

LegalOrganizationTypeId

integer

No

Lookup - MetatypeId = 10 (Legal Organization Type)

  • 1000 - Unknown
  • 1001 - Sole Proprietorships
  • 1002 - Partnerships
  • 1003 - Corporations
  • 1004 - S Corporations
  • 1005 - Limited Liability Company
  • 1007 - Non-Profit Organization

IncorporationStateCode

string

No

2 character state or province code

IncorporationCountryCode

string

No

CAN or USA

IncorporationDate

date

No

 

NumEmployees

integer

No

 

NumPartTimeEmployees

integer

No

 

LeadTypeId

integer

Yes

  • 7301 - General
  • 7302 - Accreditation

ReporterFirstName

string

No

First name of reporting contact

ReporterLastName

string

No

Last name of reporting contact

ReporterEmail

string

No

Email of reporting contact

ReporterPhone

string

No

Phone of reporting contact

ReporterNotes

string

No

Notes of reporting contact

ReporterType

string

Yes

 7404 - Partner

ReporterCategory

string

No

Actual text provided by reporter, BBB will attempt to match to an existing Category

+ Names (One Primary Required)

Collection of names that are associated with an organization

FieldType (JSON)RequiredDescription

BureauCode

string

No

 

PartnerSourceId

string

Yes

 

SourceNameId

string

No

 

Name

string

Yes

Name that the organization is known by

IsPrimary

boolean

No

Is primary name of the organization?

NameTypeId

integer

No

  • 1200 - Unknown
  • 1201 - Legal Name
  • 1202 - Doing Business As
  • 1203 - Marketing Name
  • 1204 - Search Alias
  • 1205 - Other
  • 1206 - Alternate Name

+ URLs (Not Required)

Collection of URL's that are associated with an organization

FieldType (JSON)RequiredDescription

BureauCode

string

No

 

PartnerSourceId

string

Yes

 

SourceURLId

string

No

 

URL

string

Yes

 

IsPrimary

boolean

No

 

URLTypeId

integer

No

Default = 700

  • 700 - Unknown
  • 701 - Primary Web Site
  • 702 - Customer Support
  • 703 - Facebook
  • 704 - Twitter
  • 705 - LinkedIn
  • 706 - YouTube
  • 707 - Flickr
  • 708 - Google Plus
  • 709 - Bureau
  • 710 - Search
  • 711 - File
  • 712 - Report
  • 713 - Local Report
  • 714 - eQuote
  • 715 - Reason for Rating
  • 716 - Facebook Like Button
  • 720 - Other

+ Addresses (not required)

Collection of addresses that are associated with an organization

FieldType (JSON)RequiredDescription

BureauCode

string

No

 

PartnerSourceId

string

Yes

 

SourceAddressId

string

No

 

AddressLine1

string

Yes

 

AddressLine2

string

No

 

City

string

No

 

StateCode

string

No

 

PostalCode

string

No

 

CountryCode

string

No

 

IsPrimary

boolean

No

 

AddressTypeId

integer

No

Default = 101

  • 100 - Unknown
  • 101 - Primary Address
  • 102 - Legal Address
  • 103 - Mailing Address
  • 104 - Billing Address
  • 105 - Delivery Address
  • 106 - Physical Location
  • 107 - Other Address

Latitude

numeric

No

 

Longitude

numeric

No

 

+ EmailAddresses (not required)

Collection of email addresses that are associated with an organization

FieldType (JSON)RequiredDescription

BureauCode

string

No

 

PartnerSourceId

string

Yes

 

SourceEmailId

string

No

 

EmailAddress

string

Yes

 

IsPrimary

boolean

No

 

EmailTypeId

string

No

Default = 501

  • 500 - Unknown
  • 501 - Primary E-mail
  • 502 - Complaint E-mail
  • 503 - Inquiry E-mail
  • 504 - Sales E-mail
  • 505 - Other E-mail

+ PhoneNumbers (not required)

Collection of phone numbers that are associated with an organization

FieldType (JSON)RequiredDescription

BureauCode

string

No

 

PartnerSourceId

string

Yes

 

SourcePhoneId

string

No

 

PhoneCountryCode

string

No

 

AreaCode

string

No

 

PhoneNumber

string

Yes

 

Extension

string

No

 

IsPrimary

boolean

No

 

PhoneTypeId

integer

No

Default = 301

  • 300 - Unknown
  • 301 - Primary Phone
  • 302 - Primary Fax
  • 303 - Customer Support Phone
  • 304 - Customer Support Fax
  • 305 - Legal Department Phone
  • 306 - Legal Department Fax
  • 307 - Other Phone
  • 308 - Other Fax

+ Categories (not required)

Collection of Categories that are associated with an organization

FieldType (JSON)RequiredDescription

BureauCode

string

No

 

PartnerSourceId

string

Yes

 

CategoryId

string

Yes

 

CategoryTypeId

integer

No

  • 5502 - NAICS

IsPrimary

boolean

No