MImiddesk
businesses

Update a business

Changed on
patch/v1/businesses/{id}

Request

Path parameters

idstring required

Business ID

Request body

namestring
status'in_review' | 'approved' | 'rejected'

Status to set for the business (only final statuses allowed)

external_idstring
unique_external_idstring
tagsstring[]

Response

business updated

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_typesBusinessSupportedDocumentTypesItem[]
business_batch_idstring uuid nullable
created_atstring date-time required
updated_atstring date-time required

Changes

  • adc98c847a77Revision changes
    • warning

      added the new international_business_verification enum value to the // response property for the response status

  • a32370f9357eRevision changes
    • warning

      added the new People NPI Match enum value to the //// response property for the response status

    • warning

      added the new person_npi_match enum value to the //// response property for the response status

    • info

      added the new optional request property //

    • info

      added the optional property // to the response with the status