Sign in
businesses

Create a business

post/v1/businesses

Headers

Authorizationstring required

Bearer authentication

Request body

namestring required
external_idstring
unique_external_idstring
tagsstring[]
connection_idstring

The ID of a connection to use as the source for this business. Pre-fills the business name and address from the connection.

Response

business created

objectstring required
idstring uuid required
external_idstring nullable
unique_external_idstring nullable
namestring required
status'open' | 'pending' | 'in_audit' | 'in_review' | 'approved' | 'rejected' required

Current status of the business verification

tagsstring[]
assignee_idstring uuid nullable
supported_document_typesTypeBusinessSupportedDocumentTypesItem[]
business_batch_idstring uuid nullable
created_atstring date-time required
updated_atstring date-time required

Changes

Changed in 7 of the 8 revisions of this API.10274

  • b496a7929e98125See the full diff
    • ▲

      added the pattern ^\d{5}(?:[-\s]\d{4})?$ to the request property addresses/items/oneOf[subschema #2: SubmittedAddressComponent]/postal_code

      request-property-pattern-added

    • ●

      the addresses/items/oneOf[subschema #1: SubmittedAddressFull]/reference request property's maxLength was set to 64

      request-property-max-length-set

    • ●

      the addresses/items/oneOf[subschema #2: SubmittedAddressComponent]/reference request property's maxLength was set to 64

      request-property-max-length-set

    • ○

      the addresses/items/postal_code response's property pattern ^\d{5}(?:[-\s]\d{4})?$ was added for the status 201

      response-property-pattern-added

    • ○

      the bankruptcies/items/business_id response's property pattern ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4{1}[a-fA-F0-9]{3}-[89abAB]{1}[a-fA-F0-9]{3}-[a-fA-F0-9]{12}$ was added for the status 201

      response-property-pattern-added

    • ○

      the bankruptcies/items/id response's property pattern ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4{1}[a-fA-F0-9]{3}-[89abAB]{1}[a-fA-F0-9]{3}-[a-fA-F0-9]{12}$ was added for the status 201

      response-property-pattern-added

    • ○

      the certifications/items/business_id response's property pattern ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4{1}[a-fA-F0-9]{3}-[89abAB]{1}[a-fA-F0-9]{3}-[a-fA-F0-9]{12}$ was added for the status 201

      response-property-pattern-added

    • ○

      the certifications/items/id response's property pattern ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4{1}[a-fA-F0-9]{3}-[89abAB]{1}[a-fA-F0-9]{3}-[a-fA-F0-9]{12}$ was added for the status 201

      response-property-pattern-added

  • 015f33b27f132See the full diff
    • ○

      added the optional property review/oneOf[subschema #1: Review]/analyst_read_generated_at to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property review/oneOf[subschema #1: Review]/analyst_read_markdown to the response with the 201 status

      response-optional-property-added

  • f849b82a42e13See the full diff
    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 503

      response-non-success-status-added

    • ○

      added the optional property submitted/name_derived to the response with the 201 status

      response-optional-property-added

  • 9882e52b445b754See the full diff
    • ▲

      the response property registrations/items/entity_type became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property registrations/items/jurisdiction became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property registrations/items/registered_agent became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property registrations/items/registration_date became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property registrations/items/source became nullable for the status 201

      response-property-became-nullable

    • ▲

      added type_:RegistrationState subschema #2 to the registrations/items/state response property oneOf list for the response status 201

      response-property-one-of-added

    • ▲

      the registrations/items/state response's property type/format changed from string/ to / for status 201

      response-property-type-changed

    • ○

      added the new optional request property registrations

      new-optional-request-property

    • ○

      added the optional property registrations/items/country_code to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property registrations/items/jurisdiction_details to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property registrations/items/submitted to the response with the 201 status

      response-optional-property-added

    • ○

      removed the AK enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the AL enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the AR enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the AZ enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the CA enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the CO enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the CT enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the DE enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the FL enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the GA enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the HI enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the IA enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the ID enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the IL enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the IN enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the KS enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the KY enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the LA enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the MA enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the MD enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the ME enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the MI enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the MN enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the MO enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the MS enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the MT enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the NC enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the ND enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the NE enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the NH enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the NJ enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the NM enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the NV enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the NY enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the OH enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the OK enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the OR enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the PA enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the RI enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the SC enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the SD enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the TN enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the TX enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the UT enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the VA enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the VT enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the WA enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the WI enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the WV enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the WY enum value from the registrations/items/state response property for the response status 201

      response-property-enum-value-removed

  • 771fb4da95021See the full diff
    • ○

      added the new optional request property phone_numbers

      new-optional-request-property

  • d142de33085b27See the full diff
    • ▲

      the response property risk/oneOf[subschema #1: BusinessRisk]/latest_assessment_id became optional for the status 201

      response-property-became-optional

    • ▲

      the response property risk/oneOf[subschema #1: BusinessRisk]/level became optional for the status 201

      response-property-became-optional

    • ○

      added the new optional request property addresses/items/oneOf[subschema #1: SubmittedAddressFull]/reference

      new-optional-request-property

    • ○

      added the new optional request property addresses/items/oneOf[subschema #2: SubmittedAddressComponent]/reference

      new-optional-request-property

    • ○

      added the optional property addresses/items/references to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property industry_classification/oneOf[subschema #1: IndustryClassification]/categories/items/risk_program_flags to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property risk/oneOf[subschema #1: BusinessRisk]/reason to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property risk/oneOf[subschema #1: BusinessRisk]/score to the response with the 201 status

      response-optional-property-added

    • ○

      added the required property risk/oneOf[subschema #1: BusinessRisk]/status to the response with the 201 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 83868e219c202See the full diff
    • ○

      added the optional property phone_numbers/items/id to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property risk to the response with the 201 status

      response-optional-property-added