Skip to main content
This is a staging build of the docs

Introducing company tags

· 2 min read
David Coplowe
Product Owner, Client Experience

We've enhanced our company data model to offer more flexibility. You can now add metadata to a company using the tags object.

What's new?

We've introduced a tags object to our company data model. Tags provide a simple way to include additional information about a company.

For example, you can use tags to set a foreign key, define an operating region or specify details about the financial services the company has requested. Each company can store up to 10 tags.

1
{
1
{
2
"id":"0498e921-9b53-4396-a412-4f2f5983b0a2",
2
"id":"0498e921-9b53-4396-a412-4f2f5983b0a2",
3
"name":"Toft stores",
3
"name":"Toft stores",
4
"description": "Requested a loan for refurb",
4
"description": "Requested a loan for refurb",
5
"redirect":"https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
5
"redirect":"https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
6
"lastSync":"2022-01-01T12:00:00.000Z",
6
"lastSync":"2022-01-01T12:00:00.000Z",
7
"created":"2022-01-01T12:00:00.000Z",
7
"created":"2022-01-01T12:00:00.000Z",
8
"createdByUserName":"Danny DeVito",
8
"createdByUserName":"Danny DeVito",
9
+
"tags": { 
10
+
    "uid": "cust_1MtJUT2eZvKYlo2CNaw2HvEv"
11
+
    "region": "us",
12
+
    "owningTeam": "commercial-lending"
13
+
    "loanSize": "large",
14
+
},
9
}
15
}

Key benefits

  • Group companies effectively: use tags to group companies by type or other relevant criteria.
  • Support event-based architectures: all webhooks related to a specific company now include the tags object so your webhook consumer can access this data easily.
  • Filter webhooks to specific consumers: direct webhook messages for specific companies to the appropriate webhook endpoints. See how you can filter webhooks using company tags.

Who is it relevant for?

Any client looking to add metadata to their companies in Codat, route webhooks efficiently, or pass important information into their event-based architecture.

How to get started?

This feature is available to all clients today. Start with our documentation to add metadata to a company.