Create a business entity
post
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier for the agency associated with the business entity.
-
ApplicantPartyId: integer
The unique identifier for the applicant party.
-
BusAddressFour: string
Title:
Address 4
Maximum Length:240
The fourth line of the entity address. -
BusAddressOne: string
Title:
Address 1
Maximum Length:240
The first line of the entity address. -
BusAddressThree: string
Title:
Address 3
Maximum Length:240
The third line of the entity address. -
BusAddressTwo: string
Title:
Address 2
Maximum Length:240
The second line of the entity address. -
BusBusinessLegalName: string
Title:
Legal Name
Maximum Length:360
The legally registered name of the business entity. -
BusCity: string
Title:
City
Maximum Length:60
City of the entity address. -
BusCountry: string
Title:
Country
Maximum Length:2
Country of the entity address. -
BusDbaBusinessName: string
Title:
Doing Business As
Doing business as (DBA) name of the business entity. -
BusDisadvOwnedFlag: string
Title:
Disadvantaged Enterprise
Maximum Length:30
Indicates whether the business is classified as disadvantaged by the U.S. Department of Transportation. -
BusEmployerIdNumber: string
The employer ID for the business entity.
-
BusEnabledFlag: string
Maximum Length:
1
Indicates whether the business entity is enabled. -
BusExemptFlag: string
Maximum Length:
1
Indicates whether the business entity is exempt from license fees. -
BusExemptPct: integer
(int32)
Percentage of the exemption for the business entity.
-
BusExemptType: string
Maximum Length:
30
Type of exemption for the business entity. -
BusFedTaxId: string
Title:
Business Tax ID
Maximum Length:20
Taxpayer identification number, often unique identifier of person or organization. Can be SSN or income taxpayer ID in US, fiscal code or NIF in Europe. -
BusFemaleOwnedFlag: string
Title:
Woman Owned
Maximum Length:30
Indicates whether the business is primarily owned by women. -
BusHideInfoFlag: boolean
Title:
Hide Business from Public View
Maximum Length:1
Default Value:false
The business to show or hide the information to public users. -
BusInactiveReason: string
Maximum Length:
1000
The reason that the business entity was inactivated. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier for the business entity. -
BusinessEntityKey: integer
(int64)
System-generated identifier for a business entity.
-
BusinessLocation: array
Business Locations
Title:
Business Locations
The business locations resource is used to create and update business locations. -
BusinessLocationId: string
Maximum Length:
50
The unique identifier for a business location. -
BusinessOwner: array
Business Owners
Title:
Business Owners
The business owners resource is used to create and update business owners. -
BusMinorityOwnedFlag: string
Title:
Minority Owned
Maximum Length:30
Indicates whether the business is primarily owned by a minority. -
BusOwnershipType: string
Title:
Ownership Type
Maximum Length:15
Business entity ownership type. -
BusPartyId: integer
(int64)
Business entity party ID.
-
BusPostalCode: string
Title:
Postal Code
Maximum Length:60
Business entity postal code. -
BusPostalPlusCode: string
Maximum Length:
20
Business entity postal plus 4 code. -
BusProvince: string
Title:
Province
Maximum Length:60
Business entity province. -
BusSmallBusFlag: string
Title:
Small Business
Maximum Length:30
Indicates whether the business is classified as a small business according to the Small Business Administration guidelines. -
BusState: string
Title:
State
Maximum Length:60
Business entity state. -
BusStatus: string
Title:
Status
Maximum Length:20
The current status of the business entity. -
BusVeteranOwnedFlag: string
Title:
Veteran Owned
Maximum Length:1
Indicates whether the business is owned by a military veteran. -
County: string
Maximum Length:
60
Physical address county. -
FiscalYearendDay: integer
(int32)
The last day of the fiscal year for the business entity.
-
FiscalYearendMon: string
Maximum Length:
10
The last month of the fiscal year for the business entity. -
ObjectVersionNumber: integer
(int32)
Workflow project revision number used to define the workflow.
Nested Schema : Business Locations
Type:
array
Title:
Business Locations
The business locations resource is used to create and update business locations.
Show Source
Nested Schema : Business Owners
Type:
array
Title:
Business Owners
The business owners resource is used to create and update business owners.
Show Source
Nested Schema : publicSectorBusinessRegistrations-BusinessLocation-item-post-request
Type:
Show Source
object
-
Address1: string
Title:
Address 1
Maximum Length:240
First line of the physical address. -
Address2: string
Title:
Address 2
Maximum Length:240
Second line of the physical address. -
Address3: string
Title:
Address 3
Maximum Length:240
Third line of the physical address. -
Address4: string
Title:
Address 4
Maximum Length:240
Fourth line of the physical address. -
AddressCode: string
Maximum Length:
32
Unique identifier for the parcel address. -
AddressId: integer
(int64)
The unique identifier for the address.
-
AddressType: string
Title:
Address Type
Maximum Length:20
Attribute used for address point validation. Possible values might be main address, virtual address, shipping gate address, or others. -
AgencyId: integer
(int32)
The unique identifier of the agency associated with the business location.
-
AltPhoneAreaCode: string
Maximum Length:
20
Alternate phone area code. -
AltPhoneContactPointId: integer
(int64)
Unique identifier for the alternate phone contact.
-
AltPhoneCountryCode: string
Maximum Length:
10
Alternate phone country code. -
AltPhoneExtension: string
Maximum Length:
20
Alternate phone extension number of the location. -
AltPhoneNumber: string
Maximum Length:
40
Alternate phone number of the location. -
AltPhoneType: string
Maximum Length:
30
Alternate phone type of the location. -
AltRawPhoneNumber: string
Maximum Length:
60
Alternate raw phone number of the location. -
AreaSize: integer
(int64)
Size of the business location.
-
AreaSizeUom: string
Maximum Length:
10
Unit of measure for the business location size. -
BuildingType: string
Maximum Length:
20
Building type used for parcel address searches. -
BusCategory: string
Maximum Length:
50
The category for the business. -
BusDbaBusinessName: string
Title:
Doing Business As
Maximum Length:360
The operating name of the business. -
BusDescription: string
Title:
Business Description
Maximum Length:2000
Description of the business. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier for the business entity associated with the location. -
BusinessEntityKey: integer
(int64)
System-generated identifier for a business entity.
-
BusinessLocationId: string
Maximum Length:
50
The unique identifier for the business location. -
BusinessLocationKey: integer
(int64)
System-generated unique identifier for a business location.
-
BusinessLocationPartyId: integer
(int64)
The unique identifier for the party associated with the business location.
-
BusStateTaxId: string
Title:
State Tax ID
Maximum Length:20
State tax ID of the business location. -
BusSubCategory: string
Maximum Length:
50
The subcategory for the business. -
City: string
Title:
City
Maximum Length:60
The location address city. -
CityTaxId: string
Title:
City Tax ID
Maximum Length:20
The unique tax identifier issued to the business by the city. -
CoordinateX: number
Geographic X-coordinate of the parcel address location.
-
CoordinateY: number
Geographic Y-coordinate of the parcel address location.
-
Country: string
Title:
Country
Maximum Length:2
The location address country. -
County: string
Maximum Length:
60
Physical address county. -
CrossroadOne: string
Maximum Length:
240
Cross road 1 that is part of parcel address. -
CrossroadTwo: string
Maximum Length:
240
Cross road 2 that is part of parcel address. -
CtyFoodSerLicExp: string
(date)
Expiration date of the county food service license associated with the business location.
-
CtyFoodSerLicNum: string
Maximum Length:
30
County food service license number of the business location. -
EcontactAvailabilityOne: string
Maximum Length:
1000
Availability of the primary emergency contact. -
EcontactAvailabilityTwo: string
Maximum Length:
1000
Availability of the secondary emergency contact. -
EcontactEmailOne: string
Maximum Length:
320
Email address of the primary emergency contact. -
EcontactEmailTwo: string
Maximum Length:
320
Email address of the secondary emergency contact. -
EcontactFirstNameOne: string
Title:
Contact 1 First Name
Maximum Length:150
First name of the primary emergency contact. -
EcontactFirstNameTwo: string
Title:
Contact 2 First Name
Maximum Length:150
First name of the secondary emergency contact. -
EcontactLastNameOne: string
Title:
Contact 1 Last Name
Maximum Length:150
Last name of the primary emergency contact. -
EcontactLastNameTwo: string
Title:
Contact 2 Last Name
Maximum Length:150
Last name of the secondary emergency contact. -
EcontactPhoneAreaCodeOne: string
Title:
Emergency Contact Phone Area Code 1
Maximum Length:20
Primary emergency contact area code. -
EcontactPhoneAreaCodeTwo: string
Title:
Emergency Contact Phone Area Code 2
Maximum Length:20
Secondary emergency contact area code. -
EcontactPhoneCountryOne: string
Title:
Emergency Contact Phone Country 1
Maximum Length:10
Primary emergency contact country. -
EcontactPhoneCountryTwo: string
Title:
Emergency Contact Phone Country 2
Maximum Length:10
Secondary emergency contact country code. -
EcontactPhoneExtensionOne: string
Title:
Emergency Contact Phone Extension 1
Maximum Length:20
Primary emergency contact phone extension number of the location. -
EcontactPhoneExtensionTwo: string
Title:
Emergency Contact Phone Extension 2
Maximum Length:20
Secondary emergency contact phone extension number of the location. -
EcontactPhoneNumberOne: string
Title:
Emergency Contact Phone Number 1
Maximum Length:40
Primary emergency contact phone number of the location. -
EcontactPhoneNumberTwo: string
Title:
Emergency Contact Phone Number 2
Maximum Length:40
Secondary emergency contact phone number of the location. -
EcontactPhoneTypeOne: string
Title:
Emergency Contact Phone Type 1
Maximum Length:30
Phone type of the primary emergency contact for the location. -
EcontactPhoneTypeTwo: string
Title:
Emergency Contact Phone Type 2
Maximum Length:30
Secondary emergency contact phone type of the location. -
EcontactRawPhoneNumberOne: string
Maximum Length:
60
Primary emergency contact raw phone number of the location. -
EcontactRawPhoneNumberTwo: string
Maximum Length:
60
Secondary emergency contact raw phone number of the location. -
EmailAddress: string
Title:
Email
Maximum Length:320
Email address of the location. -
EmployeeTotal: integer
Total number of employees in organization.
-
EnabledFlag: string
Maximum Length:
1
Indicates whether the business location has been enabled. -
EndDate: string
(date)
The end date of the business location.
-
EOnePhoneContactPointId: integer
(int64)
The unique identifier for the primary phone contact.
-
ETwoPhoneContactPointId: integer
(int64)
The unique identifier for the secondary phone contact.
-
Floor: string
Maximum Length:
40
The floor number of the physical address. -
InactiveReason: string
Maximum Length:
1000
The reason that the business location was inactivated. -
Landmark: string
Maximum Length:
200
Landmark for the parcel address. -
Latitude: number
Latitude of the location.
-
LocationType: string
Title:
Location Type
Maximum Length:30
The attribute used to identify the type of location. -
Longitude: number
Longitude of the location.
-
MailingAddress1: string
Title:
Mailing Address Line 1
Maximum Length:240
First line of the location mailing address. -
MailingAddress2: string
Title:
Mailing Address Line 2
Maximum Length:240
Third line of the location mailing address. -
MailingAddress3: string
Maximum Length:
240
Second line of the location mailing address. -
MailingAddress4: string
Maximum Length:
240
Fourth line of the location mailing address. -
MailingCity: string
Title:
Mailing City
Maximum Length:60
Location mailing address city. -
MailingCountry: string
Title:
Mailing Country
Maximum Length:2
Location mailing address country. -
MailingCounty: string
Title:
Mailing County
Maximum Length:60
Location mailing address county. -
MailingPostalCode: string
Title:
Mailing Postal Code
Maximum Length:60
Location mailing address postal code. -
MailingPostalPlusFourCode: string
Maximum Length:
20
Location mailing postal plus 4 code. -
MailingProvince: string
Title:
Mailing Province
Maximum Length:60
Location mailing address province. -
MailingState: string
Title:
Mailing State
Maximum Length:60
Location mailing address state. -
MobileBusFlag: string
Title:
Mobile Business
Maximum Length:1
Indicates whether the business is a mobile product or provides mobile service. -
MunicipalityId: string
Maximum Length:
20
The municipality in which the parcel address is located. -
ObjectVersionNumber: integer
(int32)
Workflow project revision number used to define the workflow.
-
OtherTaxId: string
Maximum Length:
20
The unique tax identifier issued to the business by the county. -
ParcelId: integer
(int64)
The unique identifier for the parcel.
-
ParcelIdEntered: string
Maximum Length:
30
The parcel number. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
Physical address postal code. -
PostalPlus4Code: string
Maximum Length:
20
Physical address postal plus 4 code. -
PrimaryPhoneAreaCode: string
Title:
Primary Phone Area Code
Maximum Length:20
Primary phone area code. -
PrimaryPhoneCountryCode: string
Title:
Primary Phone Country Code
Maximum Length:10
Primary phone country code. -
PrimaryPhoneExtension: string
Title:
Primary Phone Extension
Maximum Length:20
Primary phone extension number of the location. -
PrimaryPhoneNumber: string
Title:
Primary Phone
Maximum Length:40
Primary phone number of the location. -
PrimaryPhoneType: string
Title:
Primary Phone Type
Maximum Length:30
Primary phone type of the location. -
PrimaryRawPhoneNumber: string
Maximum Length:
60
Primary raw phone number of the location. -
PrimPhoneContactPointId: integer
(int64)
The unique identifier of the primary phone contact.
-
Province: string
Title:
Province
Maximum Length:60
Physical address province. -
RentalUnitNum: integer
(int64)
Number of rental units for the business location.
-
SameMailAddressFlag: string
Maximum Length:
1
Indicates whether the mailing address is same as mailing address. -
SellPerNum: string
Maximum Length:
30
Business sellers permit number of the location. -
SellPerNumExp: string
(date)
Expiration date of the business sellers permit number associated with the location.
-
StartDate: string
(date)
Title:
Start Date
The start date of the business location. -
State: string
Title:
State
Maximum Length:60
Physical address state. -
Status: string
Maximum Length:
20
Current status of the location. -
StQualPerNum: string
Maximum Length:
30
The ID number issued to the business by the State Equalization Board. -
StreetDirection: string
Maximum Length:
50
Street direction of the location. -
StreetName: string
Maximum Length:
240
Street name used for parcel address searches. -
StreetNumber: string
Maximum Length:
240
Street number of the location. -
StreetSuffix: string
Maximum Length:
20
Street name that describes the street. -
StreetType: string
Maximum Length:
20
Street type used for parcel address searches. -
TaxClass: string
Maximum Length:
30
Municipal tax class of the business location. -
UnitNumber: string
Maximum Length:
30
Apartment unit number used for parcel address searches. -
Website: string
Maximum Length:
1000
Website address of the location. -
WithinJurisdictionFlag: string
Title:
Within Jurisdiction
Maximum Length:1
Indicates whether the business is located within the agency's jurisdiction.
Nested Schema : schema
Type:
Show Source
object
-
Address1: string
Title:
Address 1
Maximum Length:240
First line of the physical address. -
Address2: string
Title:
Address 2
Maximum Length:240
Second line of the physical address. -
Address3: string
Title:
Address 3
Maximum Length:240
Third line of the physical address. -
Address4: string
Title:
Address 4
Maximum Length:240
Fourth line of the physical address. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifer for the agency. -
BePersonId: string
Maximum Length:
200
Unique identifier of the business owner. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier for a business entity. -
BusinessEntityKey: integer
(int64)
System-generated identifier for a business entity.
-
CitizenshipStatus: string
Title:
Citizenship Status
Maximum Length:30
The attribute used to identify the citizenship status of a owner. -
City: string
Title:
City
Maximum Length:60
Physical address city. -
ContactDmvLicExp: string
(date)
The contact DMV license expiration date.
-
ContactDmvLicNum: string
Maximum Length:
30
The contact DMV license number. -
ContactDmvLicSt: string
Maximum Length:
60
The contact DMV license state. -
ContactType: string
Maximum Length:
30
The contact type of the owner. -
Country: string
Title:
Country
Maximum Length:2
Physical address country. -
County: string
Maximum Length:
60
The physical address of the county. -
DateOfBirth: string
(date)
The business owner's date of birth.
-
EmailAddress: string
Title:
Email
Maximum Length:320
Email address of the business owner. -
EmergencyContactFlag: string
Indicates whether the owner is an emergency contact.
-
EmergencyContactPhone: string
Title:
Emergency Contact Phone
The phone number of the emergency contact. -
EntityAccess: string
Maximum Length:
3
The entity access of the owner. -
EntityPartyId: integer
(int64)
The entity party identifier of the owner.
-
MailingAddress1: string
Title:
Mailing Address Line 1
Maximum Length:240
First line of the location owner mailing address. -
MailingAddress2: string
Title:
Mailing Address Line 2
Maximum Length:240
Second line of the location mailing address. -
MailingAddress3: string
Maximum Length:
240
Third line of the location mailing address. -
MailingAddress4: string
Maximum Length:
240
Fourth line of the location owner mailing address. -
MailingAddressId: string
The unique identifier for the mailing address.
-
MailingCity: string
Title:
Mailing City
Maximum Length:60
Mailing address city. -
MailingCountry: string
Title:
Mailing Country
Maximum Length:2
Mailing address country. -
MailingCounty: string
Title:
Mailing County
Maximum Length:60
Mailing address county. -
MailingPostalCode: string
Title:
Mailing Postal Code
Maximum Length:60
Mailing address postal code. -
MailingPostalPlusFourCode: string
Maximum Length:
20
Location mailing postal plus 4 code. -
MailingProvince: string
Title:
Mailing Province
Maximum Length:60
Mailing address province. -
MailingState: string
Title:
Mailing State
Maximum Length:60
Mailing address state. -
ObjectVersionNumber: integer
(int32)
Workflow project revision number used to define the workflow.
-
OwnerProfileId: integer
(int64)
The owner profile identifier of the owner.
-
OwnershipPct: number
The person's percentage of ownership in the business.
-
PersonFirstName: string
Title:
First Name
Maximum Length:150
First name of the business owner. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
Last name of the business owner. -
PersonLengthAtAddress: integer
(int64)
The length of time that the person has been at this address.
-
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
Middle name of the business owner. -
PersonNameSuffix: string
Maximum Length:
30
The name suffix of the business owner. -
PersonPreNameAdjunct: string
Maximum Length:
60
Person's pre name adjunct. -
PersonTitle: string
Maximum Length:
100
The title of the business owner. -
PersonType: string
The person type for the business owner.
-
PhoneAreaCode: string
Maximum Length:
20
Phone number area code. -
PhoneCountryCode: string
Maximum Length:
10
Phone number country code. -
PhoneExtension: string
Maximum Length:
20
Phone extension number. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
Phone number. -
PhoneType: string
Title:
Phone Type
Maximum Length:30
Phone type. -
PostalCode: string
Maximum Length:
60
Physical address postal code. -
PostalPlus4Code: string
Maximum Length:
20
Physical address postal plus 4 code. -
Province: string
Title:
Province
Maximum Length:60
Physical address province. -
RawPhoneNumber: string
Maximum Length:
60
Raw phone number. -
ReferenceKey: integer
(int64)
System-generated unique identifier for an owner.
-
ReferencePartyId: integer
(int64)
Unique identifier for the reference party.
-
ReferencePuid: string
Maximum Length:
50
System-generated reference key PUID. -
RelationShipToBusiness: string
The owner's relationship to the business.
-
SameAsApplicantFlag: string
Maximum Length:
1
Indicates the mailing address is the same as the applicant's. -
SameMailAddressFlag: string
Maximum Length:
1
Indicates that the mailing address is the same as the physical address. -
State: string
Title:
State
Maximum Length:60
Physical address state. -
Status: string
Maximum Length:
30
Current status of the location. -
VerificationDate: string
(date)
The date that the responsible person was verified.
-
VerificationStatus: string
Maximum Length:
30
The verification status for the responsible person. -
VerifiedBy: string
Maximum Length:
30
Identifies who verified the responsible person.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorBusinessRegistrations-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier for the agency associated with the business entity.
-
ApplicantPartyId: integer
The unique identifier for the applicant party.
-
BusAddressFour: string
Title:
Address 4
Maximum Length:240
The fourth line of the entity address. -
BusAddressOne: string
Title:
Address 1
Maximum Length:240
The first line of the entity address. -
BusAddressThree: string
Title:
Address 3
Maximum Length:240
The third line of the entity address. -
BusAddressTwo: string
Title:
Address 2
Maximum Length:240
The second line of the entity address. -
BusBusinessLegalName: string
Title:
Legal Name
Maximum Length:360
The legally registered name of the business entity. -
BusCity: string
Title:
City
Maximum Length:60
City of the entity address. -
BusCountry: string
Title:
Country
Maximum Length:2
Country of the entity address. -
BusDbaBusinessName: string
Title:
Doing Business As
Doing business as (DBA) name of the business entity. -
BusDisadvOwnedFlag: string
Title:
Disadvantaged Enterprise
Maximum Length:30
Indicates whether the business is classified as disadvantaged by the U.S. Department of Transportation. -
BusEmployerIdNumber: string
The employer ID for the business entity.
-
BusEnabledFlag: string
Maximum Length:
1
Indicates whether the business entity is enabled. -
BusExemptFlag: string
Maximum Length:
1
Indicates whether the business entity is exempt from license fees. -
BusExemptPct: integer
(int32)
Percentage of the exemption for the business entity.
-
BusExemptType: string
Maximum Length:
30
Type of exemption for the business entity. -
BusFedTaxId: string
Title:
Business Tax ID
Maximum Length:20
Taxpayer identification number, often unique identifier of person or organization. Can be SSN or income taxpayer ID in US, fiscal code or NIF in Europe. -
BusFemaleOwnedFlag: string
Title:
Woman Owned
Maximum Length:30
Indicates whether the business is primarily owned by women. -
BusHideInfoFlag: boolean
Title:
Hide Business from Public View
Maximum Length:1
Default Value:false
The business to show or hide the information to public users. -
BusInactiveReason: string
Maximum Length:
1000
The reason that the business entity was inactivated. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier for the business entity. -
BusinessEntityKey: integer
(int64)
System-generated identifier for a business entity.
-
BusinessLocation: array
Business Locations
Title:
Business Locations
The business locations resource is used to create and update business locations. -
BusinessLocationId: string
Maximum Length:
50
The unique identifier for a business location. -
BusinessOwner: array
Business Owners
Title:
Business Owners
The business owners resource is used to create and update business owners. -
BusMinorityOwnedFlag: string
Title:
Minority Owned
Maximum Length:30
Indicates whether the business is primarily owned by a minority. -
BusOwnershipType: string
Title:
Ownership Type
Maximum Length:15
Business entity ownership type. -
BusPartyId: integer
(int64)
Business entity party ID.
-
BusPostalCode: string
Title:
Postal Code
Maximum Length:60
Business entity postal code. -
BusPostalPlusCode: string
Maximum Length:
20
Business entity postal plus 4 code. -
BusProvince: string
Title:
Province
Maximum Length:60
Business entity province. -
BusSmallBusFlag: string
Title:
Small Business
Maximum Length:30
Indicates whether the business is classified as a small business according to the Small Business Administration guidelines. -
BusState: string
Title:
State
Maximum Length:60
Business entity state. -
BusStatus: string
Title:
Status
Maximum Length:20
The current status of the business entity. -
BusVeteranOwnedFlag: string
Title:
Veteran Owned
Maximum Length:1
Indicates whether the business is owned by a military veteran. -
County: string
Maximum Length:
60
Physical address county. -
CreationDate: string
(date-time)
Read Only:
true
The date that the business entity was created. -
FiscalYearendDay: integer
(int32)
The last day of the fiscal year for the business entity.
-
FiscalYearendMon: string
Maximum Length:
10
The last month of the fiscal year for the business entity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Workflow project revision number used to define the workflow.
Nested Schema : Business Locations
Type:
array
Title:
Business Locations
The business locations resource is used to create and update business locations.
Show Source
Nested Schema : Business Owners
Type:
array
Title:
Business Owners
The business owners resource is used to create and update business owners.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorBusinessRegistrations-BusinessLocation-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address 1
Maximum Length:240
First line of the physical address. -
Address2: string
Title:
Address 2
Maximum Length:240
Second line of the physical address. -
Address3: string
Title:
Address 3
Maximum Length:240
Third line of the physical address. -
Address4: string
Title:
Address 4
Maximum Length:240
Fourth line of the physical address. -
AddressCode: string
Maximum Length:
32
Unique identifier for the parcel address. -
AddressId: integer
(int64)
The unique identifier for the address.
-
AddressType: string
Title:
Address Type
Maximum Length:20
Attribute used for address point validation. Possible values might be main address, virtual address, shipping gate address, or others. -
AgencyId: integer
(int32)
The unique identifier of the agency associated with the business location.
-
AltPhoneAreaCode: string
Maximum Length:
20
Alternate phone area code. -
AltPhoneContactPointId: integer
(int64)
Unique identifier for the alternate phone contact.
-
AltPhoneCountryCode: string
Maximum Length:
10
Alternate phone country code. -
AltPhoneExtension: string
Maximum Length:
20
Alternate phone extension number of the location. -
AltPhoneNumber: string
Maximum Length:
40
Alternate phone number of the location. -
AltPhoneType: string
Maximum Length:
30
Alternate phone type of the location. -
AltRawPhoneNumber: string
Maximum Length:
60
Alternate raw phone number of the location. -
AreaSize: integer
(int64)
Size of the business location.
-
AreaSizeUom: string
Maximum Length:
10
Unit of measure for the business location size. -
BuildingType: string
Maximum Length:
20
Building type used for parcel address searches. -
BusCategory: string
Maximum Length:
50
The category for the business. -
BusDbaBusinessName: string
Title:
Doing Business As
Maximum Length:360
The operating name of the business. -
BusDescription: string
Title:
Business Description
Maximum Length:2000
Description of the business. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier for the business entity associated with the location. -
BusinessEntityKey: integer
(int64)
System-generated identifier for a business entity.
-
BusinessLocationId: string
Maximum Length:
50
The unique identifier for the business location. -
BusinessLocationKey: integer
(int64)
System-generated unique identifier for a business location.
-
BusinessLocationPartyId: integer
(int64)
The unique identifier for the party associated with the business location.
-
BusStateTaxId: string
Title:
State Tax ID
Maximum Length:20
State tax ID of the business location. -
BusSubCategory: string
Maximum Length:
50
The subcategory for the business. -
City: string
Title:
City
Maximum Length:60
The location address city. -
CityTaxId: string
Title:
City Tax ID
Maximum Length:20
The unique tax identifier issued to the business by the city. -
CoordinateX: number
Geographic X-coordinate of the parcel address location.
-
CoordinateY: number
Geographic Y-coordinate of the parcel address location.
-
Country: string
Title:
Country
Maximum Length:2
The location address country. -
County: string
Maximum Length:
60
Physical address county. -
CreationDate: string
(date-time)
Read Only:
true
The date that the business location was created. -
CrossroadOne: string
Maximum Length:
240
Cross road 1 that is part of parcel address. -
CrossroadTwo: string
Maximum Length:
240
Cross road 2 that is part of parcel address. -
CtyFoodSerLicExp: string
(date)
Expiration date of the county food service license associated with the business location.
-
CtyFoodSerLicNum: string
Maximum Length:
30
County food service license number of the business location. -
EcontactAvailabilityOne: string
Maximum Length:
1000
Availability of the primary emergency contact. -
EcontactAvailabilityTwo: string
Maximum Length:
1000
Availability of the secondary emergency contact. -
EcontactEmailOne: string
Maximum Length:
320
Email address of the primary emergency contact. -
EcontactEmailTwo: string
Maximum Length:
320
Email address of the secondary emergency contact. -
EcontactFirstNameOne: string
Title:
Contact 1 First Name
Maximum Length:150
First name of the primary emergency contact. -
EcontactFirstNameTwo: string
Title:
Contact 2 First Name
Maximum Length:150
First name of the secondary emergency contact. -
EcontactLastNameOne: string
Title:
Contact 1 Last Name
Maximum Length:150
Last name of the primary emergency contact. -
EcontactLastNameTwo: string
Title:
Contact 2 Last Name
Maximum Length:150
Last name of the secondary emergency contact. -
EcontactPhoneAreaCodeOne: string
Title:
Emergency Contact Phone Area Code 1
Maximum Length:20
Primary emergency contact area code. -
EcontactPhoneAreaCodeTwo: string
Title:
Emergency Contact Phone Area Code 2
Maximum Length:20
Secondary emergency contact area code. -
EcontactPhoneCountryOne: string
Title:
Emergency Contact Phone Country 1
Maximum Length:10
Primary emergency contact country. -
EcontactPhoneCountryTwo: string
Title:
Emergency Contact Phone Country 2
Maximum Length:10
Secondary emergency contact country code. -
EcontactPhoneExtensionOne: string
Title:
Emergency Contact Phone Extension 1
Maximum Length:20
Primary emergency contact phone extension number of the location. -
EcontactPhoneExtensionTwo: string
Title:
Emergency Contact Phone Extension 2
Maximum Length:20
Secondary emergency contact phone extension number of the location. -
EcontactPhoneNumberOne: string
Title:
Emergency Contact Phone Number 1
Maximum Length:40
Primary emergency contact phone number of the location. -
EcontactPhoneNumberTwo: string
Title:
Emergency Contact Phone Number 2
Maximum Length:40
Secondary emergency contact phone number of the location. -
EcontactPhoneTypeOne: string
Title:
Emergency Contact Phone Type 1
Maximum Length:30
Phone type of the primary emergency contact for the location. -
EcontactPhoneTypeTwo: string
Title:
Emergency Contact Phone Type 2
Maximum Length:30
Secondary emergency contact phone type of the location. -
EcontactRawPhoneNumberOne: string
Maximum Length:
60
Primary emergency contact raw phone number of the location. -
EcontactRawPhoneNumberTwo: string
Maximum Length:
60
Secondary emergency contact raw phone number of the location. -
EmailAddress: string
Title:
Email
Maximum Length:320
Email address of the location. -
EmployeeTotal: integer
Total number of employees in organization.
-
EnabledFlag: string
Maximum Length:
1
Indicates whether the business location has been enabled. -
EndDate: string
(date)
The end date of the business location.
-
EOnePhoneContactPointId: integer
(int64)
The unique identifier for the primary phone contact.
-
ETwoPhoneContactPointId: integer
(int64)
The unique identifier for the secondary phone contact.
-
Floor: string
Maximum Length:
40
The floor number of the physical address. -
InactiveReason: string
Maximum Length:
1000
The reason that the business location was inactivated. -
Landmark: string
Maximum Length:
200
Landmark for the parcel address. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date that the business location was last updated. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login identifier of the person who last updated the business location. -
Latitude: number
Latitude of the location.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationType: string
Title:
Location Type
Maximum Length:30
The attribute used to identify the type of location. -
Longitude: number
Longitude of the location.
-
MailingAddress1: string
Title:
Mailing Address Line 1
Maximum Length:240
First line of the location mailing address. -
MailingAddress2: string
Title:
Mailing Address Line 2
Maximum Length:240
Third line of the location mailing address. -
MailingAddress3: string
Maximum Length:
240
Second line of the location mailing address. -
MailingAddress4: string
Maximum Length:
240
Fourth line of the location mailing address. -
MailingCity: string
Title:
Mailing City
Maximum Length:60
Location mailing address city. -
MailingCountry: string
Title:
Mailing Country
Maximum Length:2
Location mailing address country. -
MailingCounty: string
Title:
Mailing County
Maximum Length:60
Location mailing address county. -
MailingPostalCode: string
Title:
Mailing Postal Code
Maximum Length:60
Location mailing address postal code. -
MailingPostalPlusFourCode: string
Maximum Length:
20
Location mailing postal plus 4 code. -
MailingProvince: string
Title:
Mailing Province
Maximum Length:60
Location mailing address province. -
MailingState: string
Title:
Mailing State
Maximum Length:60
Location mailing address state. -
MobileBusFlag: string
Title:
Mobile Business
Maximum Length:1
Indicates whether the business is a mobile product or provides mobile service. -
MunicipalityId: string
Maximum Length:
20
The municipality in which the parcel address is located. -
ObjectVersionNumber: integer
(int32)
Workflow project revision number used to define the workflow.
-
OtherTaxId: string
Maximum Length:
20
The unique tax identifier issued to the business by the county. -
ParcelId: integer
(int64)
The unique identifier for the parcel.
-
ParcelIdEntered: string
Maximum Length:
30
The parcel number. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
Physical address postal code. -
PostalPlus4Code: string
Maximum Length:
20
Physical address postal plus 4 code. -
PrimaryPhoneAreaCode: string
Title:
Primary Phone Area Code
Maximum Length:20
Primary phone area code. -
PrimaryPhoneCountryCode: string
Title:
Primary Phone Country Code
Maximum Length:10
Primary phone country code. -
PrimaryPhoneExtension: string
Title:
Primary Phone Extension
Maximum Length:20
Primary phone extension number of the location. -
PrimaryPhoneNumber: string
Title:
Primary Phone
Maximum Length:40
Primary phone number of the location. -
PrimaryPhoneType: string
Title:
Primary Phone Type
Maximum Length:30
Primary phone type of the location. -
PrimaryRawPhoneNumber: string
Maximum Length:
60
Primary raw phone number of the location. -
PrimPhoneContactPointId: integer
(int64)
The unique identifier of the primary phone contact.
-
Province: string
Title:
Province
Maximum Length:60
Physical address province. -
RentalUnitNum: integer
(int64)
Number of rental units for the business location.
-
SameMailAddressFlag: string
Maximum Length:
1
Indicates whether the mailing address is same as mailing address. -
SellPerNum: string
Maximum Length:
30
Business sellers permit number of the location. -
SellPerNumExp: string
(date)
Expiration date of the business sellers permit number associated with the location.
-
StartDate: string
(date)
Title:
Start Date
The start date of the business location. -
State: string
Title:
State
Maximum Length:60
Physical address state. -
Status: string
Maximum Length:
20
Current status of the location. -
StQualPerNum: string
Maximum Length:
30
The ID number issued to the business by the State Equalization Board. -
StreetDirection: string
Maximum Length:
50
Street direction of the location. -
StreetName: string
Maximum Length:
240
Street name used for parcel address searches. -
StreetNumber: string
Maximum Length:
240
Street number of the location. -
StreetSuffix: string
Maximum Length:
20
Street name that describes the street. -
StreetType: string
Maximum Length:
20
Street type used for parcel address searches. -
TaxClass: string
Maximum Length:
30
Municipal tax class of the business location. -
UnitNumber: string
Maximum Length:
30
Apartment unit number used for parcel address searches. -
Website: string
Maximum Length:
1000
Website address of the location. -
WithinJurisdictionFlag: string
Title:
Within Jurisdiction
Maximum Length:1
Indicates whether the business is located within the agency's jurisdiction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorBusinessRegistrations-BusinessOwner-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address 1
Maximum Length:240
First line of the physical address. -
Address2: string
Title:
Address 2
Maximum Length:240
Second line of the physical address. -
Address3: string
Title:
Address 3
Maximum Length:240
Third line of the physical address. -
Address4: string
Title:
Address 4
Maximum Length:240
Fourth line of the physical address. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifer for the agency. -
BePersonId: string
Maximum Length:
200
Unique identifier of the business owner. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier for a business entity. -
BusinessEntityKey: integer
(int64)
System-generated identifier for a business entity.
-
CitizenshipStatus: string
Title:
Citizenship Status
Maximum Length:30
The attribute used to identify the citizenship status of a owner. -
City: string
Title:
City
Maximum Length:60
Physical address city. -
ContactDmvLicExp: string
(date)
The contact DMV license expiration date.
-
ContactDmvLicNum: string
Maximum Length:
30
The contact DMV license number. -
ContactDmvLicSt: string
Maximum Length:
60
The contact DMV license state. -
ContactType: string
Maximum Length:
30
The contact type of the owner. -
Country: string
Title:
Country
Maximum Length:2
Physical address country. -
County: string
Maximum Length:
60
The physical address of the county. -
CreationDate: string
(date-time)
Read Only:
true
The date that the business owner was created. -
DateOfBirth: string
(date)
The business owner's date of birth.
-
EmailAddress: string
Title:
Email
Maximum Length:320
Email address of the business owner. -
EmergencyContactFlag: string
Indicates whether the owner is an emergency contact.
-
EmergencyContactPhone: string
Title:
Emergency Contact Phone
The phone number of the emergency contact. -
EntityAccess: string
Maximum Length:
3
The entity access of the owner. -
EntityPartyId: integer
(int64)
The entity party identifier of the owner.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date on which the business owner was last updated. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login identifier of the person who last updated the business owner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MailingAddress1: string
Title:
Mailing Address Line 1
Maximum Length:240
First line of the location owner mailing address. -
MailingAddress2: string
Title:
Mailing Address Line 2
Maximum Length:240
Second line of the location mailing address. -
MailingAddress3: string
Maximum Length:
240
Third line of the location mailing address. -
MailingAddress4: string
Maximum Length:
240
Fourth line of the location owner mailing address. -
MailingAddressId: string
The unique identifier for the mailing address.
-
MailingCity: string
Title:
Mailing City
Maximum Length:60
Mailing address city. -
MailingCountry: string
Title:
Mailing Country
Maximum Length:2
Mailing address country. -
MailingCounty: string
Title:
Mailing County
Maximum Length:60
Mailing address county. -
MailingPostalCode: string
Title:
Mailing Postal Code
Maximum Length:60
Mailing address postal code. -
MailingPostalPlusFourCode: string
Maximum Length:
20
Location mailing postal plus 4 code. -
MailingProvince: string
Title:
Mailing Province
Maximum Length:60
Mailing address province. -
MailingState: string
Title:
Mailing State
Maximum Length:60
Mailing address state. -
ObjectVersionNumber: integer
(int32)
Workflow project revision number used to define the workflow.
-
OwnerProfileId: integer
(int64)
The owner profile identifier of the owner.
-
OwnershipPct: number
The person's percentage of ownership in the business.
-
PersonFirstName: string
Title:
First Name
Maximum Length:150
First name of the business owner. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
Last name of the business owner. -
PersonLengthAtAddress: integer
(int64)
The length of time that the person has been at this address.
-
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
Middle name of the business owner. -
PersonNameSuffix: string
Maximum Length:
30
The name suffix of the business owner. -
PersonPreNameAdjunct: string
Maximum Length:
60
Person's pre name adjunct. -
PersonTitle: string
Maximum Length:
100
The title of the business owner. -
PersonType: string
The person type for the business owner.
-
PhoneAreaCode: string
Maximum Length:
20
Phone number area code. -
PhoneCountryCode: string
Maximum Length:
10
Phone number country code. -
PhoneExtension: string
Maximum Length:
20
Phone extension number. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
Phone number. -
PhoneType: string
Title:
Phone Type
Maximum Length:30
Phone type. -
PostalCode: string
Maximum Length:
60
Physical address postal code. -
PostalPlus4Code: string
Maximum Length:
20
Physical address postal plus 4 code. -
Province: string
Title:
Province
Maximum Length:60
Physical address province. -
RawPhoneNumber: string
Maximum Length:
60
Raw phone number. -
ReferenceKey: integer
(int64)
System-generated unique identifier for an owner.
-
ReferencePartyId: integer
(int64)
Unique identifier for the reference party.
-
ReferencePuid: string
Maximum Length:
50
System-generated reference key PUID. -
RelationShipToBusiness: string
The owner's relationship to the business.
-
SameAsApplicantFlag: string
Maximum Length:
1
Indicates the mailing address is the same as the applicant's. -
SameMailAddressFlag: string
Maximum Length:
1
Indicates that the mailing address is the same as the physical address. -
State: string
Title:
State
Maximum Length:60
Physical address state. -
Status: string
Maximum Length:
30
Current status of the location. -
VerificationDate: string
(date)
The date that the responsible person was verified.
-
VerificationStatus: string
Maximum Length:
30
The verification status for the responsible person. -
VerifiedBy: string
Maximum Length:
30
Identifies who verified the responsible person.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- BusinessLocation
-
Parameters:
- BusinessEntityKey:
$request.path.BusinessEntityKey
The business locations resource is used to create and update business locations. - BusinessEntityKey:
- BusinessOwner
-
Parameters:
- BusinessEntityKey:
$request.path.BusinessEntityKey
The business owners resource is used to create and update business owners. - BusinessEntityKey: