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())

Try it

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     "people": [
128       {
129         "key": "value"
130       }
131     ],
132     "email_addresses": [
133       "email_addresses"
134     ]
135   },
136   "watchlist": {
137     "object": "watchlist",
138     "id": "id",
139     "hit_count": 1,
140     "agencies": [
141       {
142         "abbr": "abbr",
143         "name": "name",
144         "org": "org"
145       }
146     ],
147     "lists": [
148       {
149         "object": "watchlist_source",
150         "agency": "agency",
151         "agency_abbr": "agency_abbr",
152         "organization": "organization",
153         "title": "title",
154         "abbr": "abbr",
155         "results": [
156           {
157             "key": "value"
158           }
159         ]
160       }
161     ],
162     "people": [
163       {
164         "key": "value"
165       }
166     ]
167   },
168   "bankruptcies": [
169     {
170       "object": "bankruptcy",
171       "id": "id",
172       "business_id": "business_id",
173       "case_number": "case_number",
174       "case_updates": [
175         {}
176       ],
177       "chapter": 1.1,
178       "court": "court",
179       "filing_date": "2023-01-15",
180       "debtors": [
181         {}
182       ]
183     }
184   ],
185   "certifications": [
186     {
187       "object": "certification",
188       "name": "name",
189       "key": "key",
190       "certification_type": "federal",
191       "external_sources": [
192         {}
193       ],
194       "id": "id",
195       "business_id": "business_id",
196       "created_at": "2024-01-15T09:30:00Z",
197       "updated_at": "2024-01-15T09:30:00Z",
198       "entrance_date": "2024-01-15T09:30:00Z",
199       "exit_date": "2024-01-15T09:30:00Z",
200       "certification_id": "certification_id"
201     }
202   ],
203   "documents": [
204     {
205       "object": "document",
206       "id": "id",
207       "document_type": "document_type",
208       "filename": "filename",
209       "content_type": "application/pdf",
210       "size": 1,
211       "download_url": "download_url",
212       "created_at": "2024-01-15T09:30:00Z",
213       "filing_date": "2024-01-15T09:30:00Z",
214       "metadata": {
215         "key": "value"
216       }
217     }
218   ],
219   "liens": [
220     {
221       "object": "lien",
222       "type": "ucc",
223       "id": "id",
224       "business_id": "business_id",
225       "debtors": [
226         {}
227       ],
228       "secured_parties": [
229         {}
230       ],
231       "file_number": "file_number",
232       "state": "AL",
233       "status": "created",
234       "filing_date": "2023-01-15",
235       "status_category": "active",
236       "owner_id": "owner_id",
237       "owner_type": "owner_type",
238       "documents": [
239         {
240           "object": "document",
241           "id": "id",
242           "document_type": "document_type",
243           "filename": "filename",
244           "content_type": "application/pdf",
245           "size": 1,
246           "download_url": "download_url",
247           "created_at": "2024-01-15T09:30:00Z"
248         }
249       ],
250       "updated_date": "2023-01-15",
251       "lapse_date": "2023-01-15",
252       "collateral": "collateral",
253       "collateral_type": "Blanket",
254       "negative_pledge": true,
255       "confirmation_number": "confirmation_number",
256       "loan_principal_amount_cents": 1,
257       "source": "source",
258       "packet_number": "packet_number",
259       "lien_termination": {
260         "key": "value"
261       },
262       "liability_cents": 1,
263       "alternative_designation": "buyer_seller"
264     }
265   ],
266   "names": [
267     {
268       "object": "name",
269       "id": "id",
270       "name": "name",
271       "submitted": true,
272       "type": "legal",
273       "business_id": "business_id",
274       "sources": [
275         {
276           "id": "id",
277           "type": "type",
278           "metadata": {
279             "key": "value"
280           }
281         }
282       ]
283     }
284   ],
285   "addresses": [
286     {
287       "object": "address",
288       "id": "id",
289       "full_address": "full_address",
290       "submitted": true,
291       "created_at": "2024-01-15T09:30:00Z",
292       "updated_at": "2024-01-15T09:30:00Z",
293       "business_id": "business_id",
294       "sources": [
295         {
296           "id": "id",
297           "type": "type",
298           "metadata": {
299             "key": "value"
300           }
301         }
302       ],
303       "rating": {
304         "risk_rating": "low"
305       },
306       "address_line1": "address_line1",
307       "address_line2": "address_line2",
308       "city": "city",
309       "state": "AL",
310       "postal_code": "postal_code",
311       "latitude": 1.1,
312       "longitude": 1.1,
313       "property_type": "commercial",
314       "deliverable": true,
315       "street_view_available": true,
316       "labels": [
317         "labels"
318       ],
319       "registered_agent_name": "registered_agent_name",
320       "cmra": true,
321       "location_count": 1,
322       "is_registered_agent": true
323     }
324   ],
325   "people": [
326     {
327       "object": "person",
328       "id": "id",
329       "name": "name",
330       "business_id": "business_id"
331     }
332   ],
333   "phone_numbers": [
334     {
335       "object": "phone_number",
336       "id": "id",
337       "number": "number",
338       "business_id": "business_id"
339     }
340   ],
341   "profiles": [
342     {
343       "object": "profile",
344       "id": "id"
345     }
346   ],
347   "registrations": [
348     {
349       "object": "registration",
350       "id": "id",
351       "business_id": "business_id",
352       "name": "name",
353       "status": "status",
354       "jurisdiction": "jurisdiction",
355       "entity_type": "entity_type",
356       "file_number": "file_number",
357       "state": "AL",
358       "sub_status": "sub_status",
359       "status_details": "status_details",
360       "addresses": [
361         "addresses"
362       ],
363       "officers": [
364         {
365           "key": "value"
366         }
367       ],
368       "registered_agent": {
369         "key": "value"
370       },
371       "registration_date": "2023-01-15",
372       "source": "source"
373     }
374   ],
375   "orders": [
376     {
377       "object": "order",
378       "id": "id",
379       "package": "identity",
380       "status": "created",
381       "business_id": "business_id",
382       "created_at": "2024-01-15T09:30:00Z",
383       "updated_at": "2024-01-15T09:30:00Z",
384       "subproducts": [
385         "articles_of_incorporation"
386       ]
387     }
388   ],
389   "industry_classification": {
390     "object": "industry_classification",
391     "id": "id",
392     "status": "pending",
393     "categories": [
394       {}
395     ],
396     "created_at": "2024-01-15T09:30:00Z",
397     "completed_at": "2024-01-15T09:30:00Z"
398   },
399   "monitor": {
400     "object": "monitor",
401     "id": "id"
402   },
403   "tax_exempt_organization": {
404     "object": "tax_exempt_organization",
405     "id": "id"
406   },
407   "fmcsa_registrations": [
408     {
409       "object": "fmcsa_registration",
410       "id": "id",
411       "dot_number": "dot_number",
412       "legal_name": "legal_name",
413       "source": "source",
414       "addresses": [
415         "addresses"
416       ],
417       "dba_name": "dba_name"
418     }
419   ],
420   "litigations": [
421     {
422       "object": "litigation",
423       "id": "id",
424       "case_name": "case_name",
425       "case_number": "case_number",
426       "case_status": "OPEN",
427       "case_type": "case_type",
428       "filing_date": "2025-06-18",
429       "party_type": "party_type",
430       "judgments": [
431         {
432           "id": "id",
433           "litigation_id": "litigation_id",
434           "docket_entry_date": "2023-01-15",
435           "text": "text",
436           "created_at": "2024-01-15T09:30:00Z",
437           "updated_at": "2024-01-15T09:30:00Z"
438         }
439       ],
440       "jurisdiction": "jurisdiction",
441       "jurisdiction_state": "jurisdiction_state"
442     }
443   ],
444   "policy_results": [
445     {
446       "object": "policy_result",
447       "id": "id",
448       "result": "result",
449       "created_at": "created_at",
450       "matched": "matched",
451       "executed": true,
452       "name": "name",
453       "details": {
454         "key": "value"
455       },
456       "owner_id": "owner_id",
457       "owner_type": "owner_type",
458       "business_id": "business_id",
459       "type_of": "type_of",
460       "policy_action_results": [
461         {
462           "object": "policy_action_result"
463         }
464       ]
465     }
466   ],
467   "politically_exposed_person_screening": {
468     "object": "pep_screening",
469     "id": "id"
470   },
471   "adverse_media_screening": {
472     "object": "adverse_media_screening",
473     "id": "id"
474   },
475   "signal": {
476     "object": "signal",
477     "id": "id",
478     "name": "name",
479     "created_at": "2024-01-15T09:30:00Z",
480     "tin": "tin",
481     "external_id": "external_id",
482     "model_slug": "model_slug",
483     "score": 1.1,
484     "business_id": "business_id",
485     "batch_id": "batch_id",
486     "requester": {
487       "id": "id",
488       "type": "type",
489       "name": "name"
490     },
491     "reasons": [
492       {
493         "category": "identification",
494         "group": "group",
495         "description": "description",
496         "code": "I301"
497       }
498     ],
499     "addresses": [
500       "addresses"
501     ],
502     "people": [
503       "people"
504     ]
505   },
506   "submitted": {
507     "object": "submitted_attributes",
508     "name": "name",
509     "entity_type": "entity_type",
510     "addresses": [
511       {
512         "key": "value"
513       }
514     ],
515     "orders": [
516       "orders"
517     ],
518     "people": [
519       {
520         "key": "value"
521       }
522     ],
523     "phone_numbers": [
524       {
525         "key": "value"
526       }
527     ],
528     "email_addresses": [
529       {
530         "key": "value"
531       }
532     ],
533     "tags": [
534       "tags"
535     ],
536     "external_id": "external_id",
537     "unique_external_id": "unique_external_id",
538     "tin": {
539       "key": "value"
540     },
541     "website": {
542       "key": "value"
543     },
544     "assignee_id": "assignee_id",
545     "formation": {
546       "key": "value"
547     },
548     "names": [
549       {
550         "key": "value"
551       }
552     ],
553     "profiles": [
554       {
555         "key": "value"
556       }
557     ]
558   },
559   "subscription": {
560     "object": "subscription",
561     "id": "id"
562   }
563 }

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 or null

requesterobject or null

assignee_idstring or nullformat: "uuid"

supported_document_typeslist of strings or null

reviewobject or null

tinobject or null

business_batch_idstring or null

formationobject or null

websiteobject or null

watchlistobject or null

bankruptcieslist of objects or null

certificationslist of objects or null

documentslist of objects or null

lienslist of objects or null

nameslist of objects or null

addresseslist of objects or null

peoplelist of objects or null

phone_numberslist of objects or null

profileslist of objects or null

registrationslist of objects or null

orderslist of objects or null

industry_classificationobject or null

monitorobject or null

tax_exempt_organizationobject or null

fmcsa_registrationslist of objects or null

litigationslist of objects or null

policy_resultslist of objects or null

politically_exposed_person_screeningobject or null

adverse_media_screeningobject or null

signalobject or null

submittedobject or null

subscriptionobject or null

Authentication

Path parameters

Request

Response

Errors