For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact SalesGet Support
HomeGuidesAPI reference
HomeGuidesAPI reference
  • Middesk API
        • GETList businesses
        • POSTCreate a business
        • GETRetrieve a business
        • PATCHUpdate a business
        • GETRetrieve a business PDF
LogoLogo
Contact SalesGet Support
Middesk APIBusiness VerificationBusinesses

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

Retrieve a business PDF

Next
Built with

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 enums
Allowed values:
reviewobject or null
tinobject or null
business_batch_idstring or nullformat: "uuid"
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
email_addresseslist 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
loanslist of objects or null
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
subscription_availabilityobject or null

Errors

404
Update Business Request Not Found Error