Update a business

PATCH

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

PATCH

/v1/businesses/:id

$ curl -X PATCH https://api.middesk.com/v1/businesses/id \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

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     "Articles of Incorporation"
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     "analyst_read_markdown": "analyst_read_markdown",
50     "analyst_read_generated_at": "2024-01-15T09:30:00Z",
51     "assignee": {
52       "object": "user",
53       "id": "id",
54       "name": "name",
55       "email": "email",
56       "roles": [
57         "roles"
58       ],
59       "created_at": "2024-01-15T09:30:00Z",
60       "image_url": "image_url",
61       "directory_managed": true,
62       "last_login_at": "2024-01-15T09:30:00Z",
63       "settings": {
64         "key": "value"
65       }
66     }
67   },
68   "tin": {
69     "business_id": "business_id",
70     "tin": "tin",
71     "name": "name",
72     "mismatch": true,
73     "unknown": true,
74     "verified": true,
75     "error": "error",
76     "updated_at": "2024-01-15T09:30:00Z",
77     "issued": true,
78     "verified_by": "verified_by"
79   },
80   "business_batch_id": "business_batch_id",
81   "formation": {
82     "created_at": "2024-01-15T09:30:00Z",
83     "updated_at": "2024-01-15T09:30:00Z",
84     "entity_type": "entity_type",
85     "formation_date": "2023-01-15",
86     "formation_state": "formation_state",
87     "sources": [
88       {
89         "id": "id",
90         "type": "type",
91         "metadata": {
92           "key": "value"
93         }
94       }
95     ]
96   },
97   "website": {
98     "object": "website",
99     "id": "id",
100     "url": "url",
101     "created_at": "2024-01-15T09:30:00Z",
102     "updated_at": "2024-01-15T09:30:00Z",
103     "status": "online",
104     "parked": true,
105     "submitted": true,
106     "business_id": "business_id",
107     "business_name_match": true,
108     "phone_numbers": [
109       {}
110     ],
111     "addresses": [
112       {}
113     ],
114     "http_status_code": 1,
115     "title": "title",
116     "description": "description",
117     "domain": {
118       "domain": "domain",
119       "domain_id": "domain_id",
120       "creation_date": "2024-01-15T09:30:00Z",
121       "expiration_date": "2024-01-15T09:30:00Z",
122       "redirected": true,
123       "url_shortener": true,
124       "resolved_url": "resolved_url"
125     },
126     "pages": [
127       {}
128     ],
129     "error": "error",
130     "category": "category",
131     "platform": "platform",
132     "posts_summary": "posts_summary",
133     "reviews_summary": "reviews_summary",
134     "names": [
135       {
136         "object": "name",
137         "id": "id",
138         "name": "name",
139         "submitted": true,
140         "business_id": "business_id",
141         "sources": [
142           {
143             "id": "id",
144             "type": "type",
145             "metadata": {
146               "key": "value"
147             }
148           }
149         ]
150       }
151     ],
152     "people": [
153       {
154         "key": "value"
155       }
156     ],
157     "email_addresses": [
158       {}
159     ],
160     "rating": {
161       "quality_rating": "low",
162       "indicators": [
163         {
164           "type": "domain_age",
165           "name": "name",
166           "rating": "positive",
167           "value": "value",
168           "description": "description"
169         }
170       ]
171     }
172   },
173   "watchlist": {
174     "object": "watchlist",
175     "id": "id",
176     "hit_count": 1,
177     "agencies": [
178       {
179         "abbr": "abbr",
180         "name": "name",
181         "org": "org"
182       }
183     ],
184     "lists": [
185       {
186         "object": "watchlist_source",
187         "agency": "agency",
188         "agency_abbr": "agency_abbr",
189         "organization": "organization",
190         "title": "title",
191         "abbr": "abbr",
192         "results": [
193           {
194             "object": "watchlist_result",
195             "id": "id",
196             "status": "status",
197             "entity_name": "entity_name",
198             "entity_aliases": [
199               "entity_aliases"
200             ],
201             "agency_information_url": "agency_information_url",
202             "agency_list_url": "agency_list_url",
203             "score": null
204           }
205         ]
206       }
207     ],
208     "people": [
209       {
210         "key": "value"
211       }
212     ]
213   },
214   "risk": {
215     "object": "risk",
216     "status": "completed",
217     "level": "low",
218     "score": 1,
219     "latest_assessment_id": "latest_assessment_id",
220     "reason": "reason"
221   },
222   "bankruptcies": [
223     {
224       "object": "bankruptcy",
225       "id": "id",
226       "business_id": "business_id",
227       "case_number": "case_number",
228       "case_updates": [
229         {}
230       ],
231       "chapter": 1.1,
232       "court": "court",
233       "filing_date": "2023-01-15",
234       "debtors": [
235         {}
236       ]
237     }
238   ],
239   "certifications": [
240     {
241       "object": "certification",
242       "name": "name",
243       "key": "key",
244       "certification_type": "federal",
245       "external_sources": [
246         {}
247       ],
248       "id": "id",
249       "business_id": "business_id",
250       "created_at": "2024-01-15T09:30:00Z",
251       "updated_at": "2024-01-15T09:30:00Z",
252       "entrance_date": "2024-01-15T09:30:00Z",
253       "exit_date": "2024-01-15T09:30:00Z",
254       "certification_id": "certification_id"
255     }
256   ],
257   "documents": [
258     {
259       "object": "document",
260       "id": "id",
261       "document_type": "document_type",
262       "filename": "filename",
263       "content_type": "application/pdf",
264       "size": 1,
265       "download_url": "download_url",
266       "created_at": "2024-01-15T09:30:00Z",
267       "filing_date": "2024-01-15T09:30:00Z",
268       "metadata": {
269         "key": "value"
270       }
271     }
272   ],
273   "liens": [
274     {
275       "object": "lien",
276       "type": "ucc",
277       "id": "id",
278       "business_id": "business_id",
279       "debtors": [
280         {}
281       ],
282       "secured_parties": [
283         {}
284       ],
285       "file_number": "file_number",
286       "state": "AL",
287       "status": "created",
288       "filing_date": "2023-01-15",
289       "status_category": "active",
290       "owner_id": "owner_id",
291       "owner_type": "owner_type",
292       "documents": [
293         {
294           "object": "document",
295           "id": "id",
296           "document_type": "document_type",
297           "filename": "filename",
298           "content_type": "application/pdf",
299           "size": 1,
300           "download_url": "download_url",
301           "created_at": "2024-01-15T09:30:00Z"
302         }
303       ],
304       "updated_date": "2023-01-15",
305       "lapse_date": "2023-01-15",
306       "collateral": "collateral",
307       "collateral_type": "Blanket",
308       "negative_pledge": true,
309       "confirmation_number": "confirmation_number",
310       "loan_principal_amount_cents": 1,
311       "source": "source",
312       "packet_number": "packet_number",
313       "lien_termination": {
314         "key": "value"
315       },
316       "liability_cents": 1,
317       "alternative_designation": "buyer_seller",
318       "filed_by_account": true
319     }
320   ],
321   "names": [
322     {
323       "object": "name",
324       "id": "id",
325       "name": "name",
326       "submitted": true,
327       "business_id": "business_id",
328       "sources": [
329         {
330           "id": "id",
331           "type": "type",
332           "metadata": {
333             "key": "value"
334           }
335         }
336       ],
337       "type": "legal"
338     }
339   ],
340   "addresses": [
341     {
342       "object": "address",
343       "id": "id",
344       "full_address": "full_address",
345       "submitted": true,
346       "created_at": "2024-01-15T09:30:00Z",
347       "updated_at": "2024-01-15T09:30:00Z",
348       "business_id": "business_id",
349       "sources": [
350         {
351           "id": "id",
352           "type": "type",
353           "metadata": {
354             "key": "value"
355           }
356         }
357       ],
358       "rating": {
359         "risk_rating": "low"
360       },
361       "address_line1": "address_line1",
362       "address_line2": "address_line2",
363       "city": "city",
364       "state": "AL",
365       "postal_code": "postal_code",
366       "latitude": 1.1,
367       "longitude": 1.1,
368       "property_type": "commercial",
369       "deliverable": true,
370       "street_view_available": true,
371       "labels": [
372         "labels"
373       ],
374       "references": [
375         "references"
376       ],
377       "registered_agent_name": "registered_agent_name",
378       "cmra": true,
379       "location_count": 1,
380       "is_registered_agent": true
381     }
382   ],
383   "people": [
384     {
385       "object": "person",
386       "id": "id",
387       "name": "name",
388       "submitted": true,
389       "business_id": "business_id",
390       "titles": [
391         {}
392       ],
393       "people_bankruptcies": [
394         {
395           "key": "value"
396         }
397       ],
398       "litigations": [
399         {
400           "object": "litigation",
401           "id": "id",
402           "case_name": "case_name",
403           "case_number": "case_number",
404           "case_status": "OPEN",
405           "case_type": "case_type",
406           "filing_date": "2025-06-18",
407           "party_type": "party_type"
408         }
409       ],
410       "liens": [
411         {
412           "object": "lien",
413           "type": "ucc",
414           "id": "id",
415           "business_id": "business_id",
416           "debtors": [
417             {}
418           ],
419           "secured_parties": [
420             {}
421           ],
422           "file_number": null,
423           "state": "AL",
424           "status": "created",
425           "filing_date": null,
426           "status_category": "active",
427           "owner_id": "owner_id",
428           "owner_type": "owner_type",
429           "documents": [
430             {
431               "object": "document",
432               "id": "id",
433               "document_type": "document_type",
434               "filename": "filename",
435               "content_type": "application/pdf",
436               "size": 1,
437               "download_url": "download_url",
438               "created_at": "2024-01-15T09:30:00Z"
439             }
440           ]
441         }
442       ],
443       "criminal_records": [
444         {
445           "object": "criminal_history/record",
446           "id": "id",
447           "category": "category",
448           "cases": [
449             {
450               "object": "criminal_history/case",
451               "charges": [
452                 {
453                   "object": "criminal_history/charge"
454                 }
455               ]
456             }
457           ]
458         }
459       ],
460       "sources": [
461         {
462           "id": "id",
463           "type": "type",
464           "metadata": {
465             "key": "value"
466           }
467         }
468       ]
469     }
470   ],
471   "phone_numbers": [
472     {
473       "object": "phone_number",
474       "id": "id",
475       "number": "number",
476       "contact_type": "contact_type",
477       "recommended": true
478     }
479   ],
480   "email_addresses": [
481     {
482       "object": "email_address",
483       "id": "id",
484       "email": "email",
485       "submitted": true,
486       "sources": [
487         {
488           "id": "id",
489           "type": "type",
490           "metadata": {
491             "key": "value"
492           }
493         }
494       ],
495       "domain": "domain",
496       "valid": true,
497       "deliverability": "deliverability",
498       "disposable": true,
499       "address_type": "disposable",
500       "business_id": "business_id",
501       "domain_age": "2024-01-15T09:30:00Z",
502       "first_seen": "2024-01-15T09:30:00Z",
503       "rating": {
504         "risk_rating": "low"
505       }
506     }
507   ],
508   "profiles": [
509     {
510       "object": "profile",
511       "id": "id",
512       "type": "facebook",
513       "url": "url",
514       "external_id": "external_id",
515       "rating": 1.1,
516       "rating_count": 1
517     }
518   ],
519   "registrations": [
520     {
521       "object": "registration",
522       "id": "id",
523       "business_id": "business_id",
524       "name": "name",
525       "status": "status",
526       "jurisdiction": "jurisdiction",
527       "entity_type": "entity_type",
528       "file_number": "file_number",
529       "state": "AL",
530       "sub_status": "sub_status",
531       "status_details": "status_details",
532       "country_code": "country_code",
533       "addresses": [
534         "addresses"
535       ],
536       "officers": [
537         {
538           "key": "value"
539         }
540       ],
541       "registered_agent": {
542         "key": "value"
543       },
544       "registration_date": "2023-01-15",
545       "source": "source",
546       "submitted": true
547     }
548   ],
549   "orders": [
550     {
551       "object": "order",
552       "id": "id",
553       "status": "created",
554       "business_id": "business_id",
555       "product": "identity",
556       "created_at": "2024-01-15T09:30:00Z",
557       "updated_at": "2024-01-15T09:30:00Z",
558       "subproducts": [
559         "Articles of Incorporation"
560       ],
561       "completed_at": "2024-01-15T09:30:00Z",
562       "monitoring": true
563     }
564   ],
565   "industry_classification": {
566     "object": "industry_classification",
567     "id": "id",
568     "status": "pending",
569     "categories": [
570       {}
571     ],
572     "created_at": "2024-01-15T09:30:00Z",
573     "completed_at": "2024-01-15T09:30:00Z",
574     "website": {
575       "status": "online",
576       "parked": true
577     }
578   },
579   "monitor": {
580     "object": "monitor",
581     "id": "id",
582     "created_at": "2024-01-15T09:30:00Z",
583     "event_types": [
584       {}
585     ]
586   },
587   "tax_exempt_organization": {
588     "object": "tax_exempt_organization",
589     "id": "id",
590     "ein": "ein",
591     "name": "name",
592     "section": "section",
593     "ruling_date": "2023-01-15",
594     "tax_period": "2023-01-15",
595     "revoked_at": "2024-01-15T09:30:00Z"
596   },
597   "fmcsa_registrations": [
598     {
599       "object": "fmcsa_registration",
600       "id": "id",
601       "dot_number": "dot_number",
602       "legal_name": "legal_name",
603       "source": "source",
604       "addresses": [
605         "addresses"
606       ],
607       "dba_name": "dba_name"
608     }
609   ],
610   "loans": [
611     {
612       "object": "loan",
613       "id": "id",
614       "issued_date": "2023-01-15",
615       "amount": 1.1,
616       "lender": "lender"
617     }
618   ],
619   "litigations": [
620     {
621       "object": "litigation",
622       "id": "id",
623       "case_name": "case_name",
624       "case_number": "case_number",
625       "case_status": "OPEN",
626       "case_type": "case_type",
627       "filing_date": "2025-06-18",
628       "party_type": "party_type",
629       "judgments": [
630         {
631           "id": "id",
632           "litigation_id": "litigation_id",
633           "docket_entry_date": "2023-01-15",
634           "text": "text",
635           "created_at": "2024-01-15T09:30:00Z",
636           "updated_at": "2024-01-15T09:30:00Z"
637         }
638       ],
639       "jurisdiction": "jurisdiction",
640       "jurisdiction_state": "jurisdiction_state",
641       "parties": [
642         {
643           "id": "id",
644           "name": "name",
645           "role": "Plaintiff",
646           "litigation_id": "litigation_id"
647         }
648       ]
649     }
650   ],
651   "policy_results": [
652     {
653       "object": "policy_result",
654       "id": "id",
655       "result": "result",
656       "created_at": "created_at",
657       "matched": "matched",
658       "executed": true,
659       "name": "name",
660       "details": {
661         "key": "value"
662       },
663       "owner_id": "owner_id",
664       "owner_type": "owner_type",
665       "business_id": "business_id",
666       "type_of": "type_of",
667       "policy_action_results": [
668         {
669           "object": "policy_action_result"
670         }
671       ]
672     }
673   ],
674   "politically_exposed_person_screening": {
675     "object": "politically_exposed_person_screening",
676     "id": "id",
677     "created_at": "2024-01-15T09:30:00Z",
678     "updated_at": "2024-01-15T09:30:00Z",
679     "results": [
680       {}
681     ],
682     "settings": {
683       "people": "people",
684       "match_score": "LOW"
685     }
686   },
687   "adverse_media_screening": {
688     "object": "adverse_media_screening",
689     "id": "id",
690     "created_at": "2024-01-15T09:30:00Z",
691     "updated_at": "2024-01-15T09:30:00Z",
692     "results": [
693       {}
694     ],
695     "exclusion_settings": {
696       "criteria_match_threshold": 1.1,
697       "max_people_screened": 1,
698       "max_names_screened": 1,
699       "people": [
700         {
701           "key": "value"
702         }
703       ]
704     }
705   },
706   "signal": {
707     "object": "signal",
708     "id": "id",
709     "name": "name",
710     "created_at": "2024-01-15T09:30:00Z",
711     "tin": "tin",
712     "external_id": "external_id",
713     "model_slug": "model_slug",
714     "score": 1.1,
715     "business_id": "business_id",
716     "batch_id": "batch_id",
717     "requester": {
718       "id": "id",
719       "type": "type",
720       "name": "name"
721     },
722     "reasons": [
723       {
724         "category": "identification",
725         "group": "group",
726         "description": "description",
727         "code": "I301"
728       }
729     ],
730     "addresses": [
731       "addresses"
732     ],
733     "people": [
734       "people"
735     ]
736   },
737   "submitted": {
738     "object": "submitted_attributes",
739     "name": "name",
740     "name_derived": true,
741     "entity_type": "entity_type",
742     "addresses": [
743       {
744         "key": "value"
745       }
746     ],
747     "orders": [
748       {}
749     ],
750     "people": [
751       {
752         "key": "value"
753       }
754     ],
755     "phone_numbers": [
756       {
757         "key": "value"
758       }
759     ],
760     "email_addresses": [
761       {
762         "key": "value"
763       }
764     ],
765     "tags": [
766       "tags"
767     ],
768     "external_id": "external_id",
769     "unique_external_id": "unique_external_id",
770     "tin": {
771       "key": "value"
772     },
773     "website": {
774       "key": "value"
775     },
776     "assignee_id": "assignee_id",
777     "formation": {
778       "key": "value"
779     },
780     "names": [
781       {
782         "key": "value"
783       }
784     ],
785     "profiles": [
786       {
787         "key": "value"
788       }
789     ]
790   },
791   "subscription": {
792     "object": "subscription",
793     "id": "id"
794   },
795   "subscription_availability": {
796     "bankruptcy": "subscribable",
797     "certification": "subscribable",
798     "registration": "subscribable",
799     "tin": "subscribable",
800     "watchlist_result": "subscribable",
801     "lien": "subscribable"
802   }
803 }

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

websiteobjectOptional

Website information for the business. Sets the submitted website URL; ignored when it resolves to the same host as the business’s existing website.

phone_numberslist of objectsOptional

Phone numbers to add to the business. Numbers that already exist on the business are ignored.

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 nullOptional

unique_external_idstring or nullOptional

tagslist of stringsOptional

requesterobject or nullOptional

assignee_idstring or nullOptionalformat: "uuid"

supported_document_typeslist of enumsOptional

reviewobject or nullOptional

tinobject or nullOptional

business_batch_idstring or nullOptionalformat: "uuid"

formationobject or nullOptional

websiteobject or nullOptional

watchlistobject or nullOptional

riskobject or nullOptional

Top-level risk outcome for the business. Populated once a Risk order reaches a terminal state (completed with a verdict, or unavailable). null while a Risk order is still in flight. This is the business-level risk outcome; granular per-resource assessments live on the Risk Assessment resource, not here.

bankruptcieslist of objectsOptional

certificationslist of objectsOptional

documentslist of objectsOptional

lienslist of objectsOptional

nameslist of objectsOptional

addresseslist of objectsOptional

peoplelist of objectsOptional

phone_numberslist of objectsOptional

email_addresseslist of objectsOptional

profileslist of objectsOptional

registrationslist of objectsOptional

orderslist of objectsOptional

industry_classificationobject or nullOptional

monitorobject or nullOptional

tax_exempt_organizationobject or nullOptional

fmcsa_registrationslist of objectsOptional

loanslist of objects or nullOptional

litigationslist of objectsOptional

policy_resultslist of objectsOptional

politically_exposed_person_screeningobject or nullOptional

adverse_media_screeningobject or nullOptional

signalobject or nullOptional

submittedobjectOptional

subscriptionobject or nullOptional

subscription_availabilityobject or nullOptional

Errors

404

Update Business Request Not Found Error