MImiddesk
registrations

Create a registration for a business

Changed on
post/v1/businesses/{business_id}/registrations

Request

Path parameters

business_idstring required

Business ID

Request body

file_numberstring required

The registration or file number issued by the international registry.

country_codestring required

ISO 3166-1 alpha-2 country code of the registry (e.g., FR, DE, GB).

Response

registration created

objectstring required
idstring uuid required
business_idstring uuid required
namestring required
statusstring required
sub_statusstring nullable
status_detailsstring nullable
jurisdictionstring nullable required

Indicates the relationship between the business and this jurisdiction. DOMESTIC or FOREIGN for US registrations; HOME or EXTRA_PROVINCIAL for Canada; UNKNOWN when undetermined; null for other international registrations.

entity_typestring nullable required
file_numberstring required
country_codestring

US for domestic registrations, or an ISO 3166-1 alpha-2 code for international registrations (e.g., FR, DE, GB).

addressesstring[]
officersobject[]
registered_agentobject nullable
registration_datestring date nullable
state'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' required

The US state for the registration. null for international registrations.

sourcestring uri nullable
submittedboolean

true if you submitted the registration, false if Middesk sourced it.

Changes

  • 4c9cd4e834baRevision changes
    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security bearer_auth was added to the API

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status

  • 668373c892ceRevision changes
    • info

      api operation id createRegistration removed and replaced with registrations_createRegistration