Skip to navigation
API ReferenceBusinesses

Update Business

Update a business of the partner.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

business_external_idstringRequired

Request

This endpoint expects an object.
namestringOptional
emailstringOptionalformat: "email"<=255 characters
phone_numberstringOptional<=32 characters
date_of_incorporationstringOptionalformat: "date"
tax_identifierstringOptional<=32 characters
address_line1stringOptional<=250 characters
address_line2stringOptional<=250 characters
address_citystringOptional<=100 characters
address_statestringOptional<=255 characters
address_zipstringOptional<=32 characters

Response

idstringformat: "uuid"
pcidstring or null
kyb_statusstring or null
tax_id_typestring or null
namestringOptional
emailstringOptionalformat: "email"<=255 characters
is_activebooleanOptional
phone_numberstringOptional<=32 characters
date_of_incorporationstringOptionalformat: "date"
tax_identifierstringOptionalRead-only
address_line1stringOptionalRead-only
address_line2stringOptionalRead-only
address_citystringOptionalRead-only
address_statestringOptionalRead-only
address_zipstringOptionalRead-only