Update a business

PATCH

https://api.middesk.com/v1/businesses/:id

PATCH

/v1/businesses/:id

1 import requests
2 
3 url = "https://api.middesk.com/v1/businesses/id"
4 
5 payload = {}
6 headers = {
7     "Authorization": "Bearer <token>",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.patch(url, json=payload, headers=headers)
12 
13 print(response.json())

1 {
2   "object": "business",
3   "id": "id",
4   "name": "name",
5   "status": "open",
6   "created_at": "2024-01-15T09:30:00Z",
7   "updated_at": "2024-01-15T09:30:00Z",
8   "external_id": "external_id",
9   "unique_external_id": "unique_external_id",
10   "tags": [
11     "tags"
12   ],
13   "requester": {
14     "id": "id",
15     "type": "account",
16     "name": "name",
17     "requested_at": "2024-01-15T09:30:00Z"
18   },
19   "assignee_id": "assignee_id",
20   "supported_document_types": [
21     "supported_document_types"
22   ],
23   "review": {
24     "object": "review",
25     "id": "id",
26     "created_at": "2024-01-15T09:30:00Z",
27     "updated_at": "2024-01-15T09:30:00Z",
28     "tasks": [
29       {
30         "category": "bankruptcies",
31         "key": "location_frequency",
32         "label": "Politically Exposed Persons",
33         "message": "message",
34         "name": "name",
35         "status": "success",
36         "sub_label": "sub_label",
37         "sources": [
38           {
39             "id": "id",
40             "type": "type",
41             "metadata": {
42               "key": "value"
43             }
44           }
45         ]
46       }
47     ],
48     "completed_at": "2024-01-15T09:30:00Z",
49     "assignee": {
50       "object": "user",
51       "id": "id",
52       "name": "name",
53       "email": "email",
54       "roles": [
55         "roles"
56       ],
57       "created_at": "2024-01-15T09:30:00Z",
58       "image_url": "image_url",
59       "directory_managed": true,
60       "last_login_at": "2024-01-15T09:30:00Z",
61       "settings": {
62         "key": "value"
63       }
64     }
65   },
66   "tin": {
67     "business_id": "business_id",
68     "tin": "tin",
69     "name": "name",
70     "mismatch": true,
71     "unknown": true,
72     "verified": true,
73     "error": "error",
74     "updated_at": "2024-01-15T09:30:00Z",
75     "issued": true,
76     "verified_by": "verified_by"
77   },
78   "business_batch_id": "business_batch_id",
79   "formation": {
80     "created_at": "2024-01-15T09:30:00Z",
81     "updated_at": "2024-01-15T09:30:00Z",
82     "entity_type": "entity_type",
83     "formation_date": "2023-01-15",
84     "formation_state": "formation_state",
85     "sources": [
86       {
87         "id": "id",
88         "type": "type",
89         "metadata": {
90           "key": "value"
91         }
92       }
93     ]
94   },
95   "website": {
96     "object": "website",
97     "id": "id",
98     "url": "url",
99     "created_at": "2024-01-15T09:30:00Z",
100     "updated_at": "2024-01-15T09:30:00Z",
101     "status": "online",
102     "parked": true,
103     "submitted": true,
104     "business_id": "business_id",
105     "business_name_match": true,
106     "phone_numbers": [
107       "phone_numbers"
108     ],
109     "addresses": [
110       "addresses"
111     ],
112     "http_status_code": 1,
113     "title": "title",
114     "description": "description",
115     "domain": {
116       "domain": "domain",
117       "domain_id": "domain_id",
118       "creation_date": "2024-01-15T09:30:00Z",
119       "expiration_date": "2024-01-15T09:30:00Z"
120     },
121     "pages": [
122       {}
123     ],
124     "error": "error",
125     "category": "category",
126     "platform": "platform",
127     "posts_summary": "posts_summary",
128     "reviews_summary": "reviews_summary",
129     "people": [
130       {
131         "key": "value"
132       }
133     ],
134     "email_addresses": [
135       "email_addresses"
136     ]
137   },
138   "watchlist": {
139     "object": "watchlist",
140     "id": "id",
141     "hit_count": 1,
142     "agencies": [
143       {
144         "abbr": "abbr",
145         "name": "name",
146         "org": "org"
147       }
148     ],
149     "lists": [
150       {
151         "object": "watchlist_source",
152         "agency": "agency",
153         "agency_abbr": "agency_abbr",
154         "organization": "organization",
155         "title": "title",
156         "abbr": "abbr",
157         "results": [
158           {
159             "object": "watchlist_result",
160             "id": "id",
161             "status": "status",
162             "entity_name": "entity_name",
163             "entity_aliases": [
164               "entity_aliases"
165             ],
166             "agency_information_url": "agency_information_url",
167             "agency_list_url": "agency_list_url"
168           }
169         ]
170       }
171     ],
172     "people": [
173       {
174         "key": "value"
175       }
176     ]
177   },
178   "bankruptcies": [
179     {
180       "object": "bankruptcy",
181       "id": "id",
182       "business_id": "business_id",
183       "case_number": "case_number",
184       "case_updates": [
185         {}
186       ],
187       "chapter": 1.1,
188       "court": "court",
189       "filing_date": "2023-01-15",
190       "debtors": [
191         {}
192       ]
193     }
194   ],
195   "certifications": [
196     {
197       "object": "certification",
198       "name": "name",
199       "key": "key",
200       "certification_type": "federal",
201       "external_sources": [
202         {}
203       ],
204       "id": "id",
205       "business_id": "business_id",
206       "created_at": "2024-01-15T09:30:00Z",
207       "updated_at": "2024-01-15T09:30:00Z",
208       "entrance_date": "2024-01-15T09:30:00Z",
209       "exit_date": "2024-01-15T09:30:00Z",
210       "certification_id": "certification_id"
211     }
212   ],
213   "documents": [
214     {
215       "object": "document",
216       "id": "id",
217       "document_type": "document_type",
218       "filename": "filename",
219       "content_type": "application/pdf",
220       "size": 1,
221       "download_url": "download_url",
222       "created_at": "2024-01-15T09:30:00Z",
223       "filing_date": "2024-01-15T09:30:00Z",
224       "metadata": {
225         "key": "value"
226       }
227     }
228   ],
229   "liens": [
230     {
231       "object": "lien",
232       "type": "ucc",
233       "id": "id",
234       "business_id": "business_id",
235       "debtors": [
236         {}
237       ],
238       "secured_parties": [
239         {}
240       ],
241       "file_number": "file_number",
242       "state": "AL",
243       "status": "created",
244       "filing_date": "2023-01-15",
245       "status_category": "active",
246       "owner_id": "owner_id",
247       "owner_type": "owner_type",
248       "documents": [
249         {
250           "object": "document",
251           "id": "id",
252           "document_type": "document_type",
253           "filename": "filename",
254           "content_type": "application/pdf",
255           "size": 1,
256           "download_url": "download_url",
257           "created_at": "2024-01-15T09:30:00Z"
258         }
259       ],
260       "updated_date": "2023-01-15",
261       "lapse_date": "2023-01-15",
262       "collateral": "collateral",
263       "collateral_type": "Blanket",
264       "negative_pledge": true,
265       "confirmation_number": "confirmation_number",
266       "loan_principal_amount_cents": 1,
267       "source": "source",
268       "packet_number": "packet_number",
269       "lien_termination": {
270         "key": "value"
271       },
272       "liability_cents": 1,
273       "alternative_designation": "buyer_seller"
274     }
275   ],
276   "names": [
277     {
278       "object": "name",
279       "id": "id",
280       "name": "name",
281       "submitted": true,
282       "business_id": "business_id",
283       "sources": [
284         {
285           "id": "id",
286           "type": "type",
287           "metadata": {
288             "key": "value"
289           }
290         }
291       ],
292       "type": "legal"
293     }
294   ],
295   "addresses": [
296     {
297       "object": "address",
298       "id": "id",
299       "full_address": "full_address",
300       "submitted": true,
301       "created_at": "2024-01-15T09:30:00Z",
302       "updated_at": "2024-01-15T09:30:00Z",
303       "business_id": "business_id",
304       "sources": [
305         {
306           "id": "id",
307           "type": "type",
308           "metadata": {
309             "key": "value"
310           }
311         }
312       ],
313       "rating": {
314         "risk_rating": "low"
315       },
316       "address_line1": "address_line1",
317       "address_line2": "address_line2",
318       "city": "city",
319       "state": "AL",
320       "postal_code": "postal_code",
321       "latitude": 1.1,
322       "longitude": 1.1,
323       "property_type": "commercial",
324       "deliverable": true,
325       "street_view_available": true,
326       "labels": [
327         "labels"
328       ],
329       "registered_agent_name": "registered_agent_name",
330       "cmra": true,
331       "location_count": 1,
332       "is_registered_agent": true
333     }
334   ],
335   "people": [
336     {
337       "object": "person",
338       "id": "id",
339       "name": "name",
340       "business_id": "business_id"
341     }
342   ],
343   "phone_numbers": [
344     {
345       "object": "phone_number",
346       "id": "id",
347       "number": "number",
348       "business_id": "business_id"
349     }
350   ],
351   "profiles": [
352     {
353       "object": "profile",
354       "id": "id",
355       "type": "facebook",
356       "url": "url",
357       "external_id": "external_id",
358       "rating": 1.1,
359       "rating_count": 1
360     }
361   ],
362   "registrations": [
363     {
364       "object": "registration",
365       "id": "id",
366       "business_id": "business_id",
367       "name": "name",
368       "status": "status",
369       "jurisdiction": "jurisdiction",
370       "entity_type": "entity_type",
371       "file_number": "file_number",
372       "state": "AL",
373       "sub_status": "sub_status",
374       "status_details": "status_details",
375       "addresses": [
376         "addresses"
377       ],
378       "officers": [
379         {
380           "key": "value"
381         }
382       ],
383       "registered_agent": {
384         "key": "value"
385       },
386       "registration_date": "2023-01-15",
387       "source": "source"
388     }
389   ],
390   "orders": [
391     {
392       "object": "order",
393       "id": "id",
394       "package": "identity",
395       "status": "created",
396       "business_id": "business_id",
397       "created_at": "2024-01-15T09:30:00Z",
398       "updated_at": "2024-01-15T09:30:00Z",
399       "subproducts": [
400         "articles_of_incorporation"
401       ]
402     }
403   ],
404   "industry_classification": {
405     "object": "industry_classification",
406     "id": "id",
407     "status": "pending",
408     "categories": [
409       {}
410     ],
411     "created_at": "2024-01-15T09:30:00Z",
412     "completed_at": "2024-01-15T09:30:00Z"
413   },
414   "monitor": {
415     "object": "monitor",
416     "id": "id"
417   },
418   "tax_exempt_organization": {
419     "object": "tax_exempt_organization",
420     "id": "id"
421   },
422   "fmcsa_registrations": [
423     {
424       "object": "fmcsa_registration",
425       "id": "id",
426       "dot_number": "dot_number",
427       "legal_name": "legal_name",
428       "source": "source",
429       "addresses": [
430         "addresses"
431       ],
432       "dba_name": "dba_name"
433     }
434   ],
435   "litigations": [
436     {
437       "object": "litigation",
438       "id": "id",
439       "case_name": "case_name",
440       "case_number": "case_number",
441       "case_status": "OPEN",
442       "case_type": "case_type",
443       "filing_date": "2025-06-18",
444       "party_type": "party_type",
445       "judgments": [
446         {
447           "id": "id",
448           "litigation_id": "litigation_id",
449           "docket_entry_date": "2023-01-15",
450           "text": "text",
451           "created_at": "2024-01-15T09:30:00Z",
452           "updated_at": "2024-01-15T09:30:00Z"
453         }
454       ],
455       "jurisdiction": "jurisdiction",
456       "jurisdiction_state": "jurisdiction_state"
457     }
458   ],
459   "policy_results": [
460     {
461       "object": "policy_result",
462       "id": "id",
463       "result": "result",
464       "created_at": "created_at",
465       "matched": "matched",
466       "executed": true,
467       "name": "name",
468       "details": {
469         "key": "value"
470       },
471       "owner_id": "owner_id",
472       "owner_type": "owner_type",
473       "business_id": "business_id",
474       "type_of": "type_of",
475       "policy_action_results": [
476         {
477           "object": "policy_action_result"
478         }
479       ]
480     }
481   ],
482   "politically_exposed_person_screening": {
483     "object": "pep_screening",
484     "id": "id"
485   },
486   "adverse_media_screening": {
487     "object": "adverse_media_screening",
488     "id": "id"
489   },
490   "signal": {
491     "object": "signal",
492     "id": "id",
493     "name": "name",
494     "created_at": "2024-01-15T09:30:00Z",
495     "tin": "tin",
496     "external_id": "external_id",
497     "model_slug": "model_slug",
498     "score": 1.1,
499     "business_id": "business_id",
500     "batch_id": "batch_id",
501     "requester": {
502       "id": "id",
503       "type": "type",
504       "name": "name"
505     },
506     "reasons": [
507       {
508         "category": "identification",
509         "group": "group",
510         "description": "description",
511         "code": "I301"
512       }
513     ],
514     "addresses": [
515       "addresses"
516     ],
517     "people": [
518       "people"
519     ]
520   },
521   "submitted": {
522     "object": "submitted_attributes",
523     "name": "name",
524     "entity_type": "entity_type",
525     "addresses": [
526       {
527         "key": "value"
528       }
529     ],
530     "orders": [
531       "orders"
532     ],
533     "people": [
534       {
535         "key": "value"
536       }
537     ],
538     "phone_numbers": [
539       {
540         "key": "value"
541       }
542     ],
543     "email_addresses": [
544       {
545         "key": "value"
546       }
547     ],
548     "tags": [
549       "tags"
550     ],
551     "external_id": "external_id",
552     "unique_external_id": "unique_external_id",
553     "tin": {
554       "key": "value"
555     },
556     "website": {
557       "key": "value"
558     },
559     "assignee_id": "assignee_id",
560     "formation": {
561       "key": "value"
562     },
563     "names": [
564       {
565         "key": "value"
566       }
567     ],
568     "profiles": [
569       {
570         "key": "value"
571       }
572     ]
573   },
574   "subscription": {
575     "object": "subscription",
576     "id": "id"
577   }
578 }

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Business ID

Request

This endpoint expects an object.

namestringOptional

statusenumOptional

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

Allowed values:

tinobjectOptional

addresseslist of objectsOptional

peoplelist of objectsOptional

external_idstringOptional

unique_external_idstringOptional

tagslist of stringsOptional

Response

business updated

objectstring

idstringformat: "uuid"

namestring

statusenum

Current status of the business verification

created_atdatetime

updated_atdatetime

external_idstring or null

unique_external_idstring or null

tagslist of strings

requesterobject or null

assignee_idstring or nullformat: "uuid"

supported_document_typeslist of strings

reviewobject or null

tinobject or null

business_batch_idstring or null

formationobject or null

websiteobject or null

watchlistobject or null

bankruptcieslist of objects

certificationslist of objects

documentslist of objects

lienslist of objects

nameslist of objects

addresseslist of objects

peoplelist of objects

phone_numberslist of objects

profileslist of objects

registrationslist of objects

orderslist of objects

industry_classificationobject or null

monitorobject or null

tax_exempt_organizationobject or null

fmcsa_registrationslist of objects

litigationslist of objects

policy_resultslist of objects

politically_exposed_person_screeningobject or null

adverse_media_screeningobject or null

signalobject or null

submittedobject

subscriptionobject or null

Errors

404

Patch V1businesses ID Request Not Found Error