Skip to main content
PATCH
Update the company and owner details of an end user

Authorizations

x-api-key
string
header
required

Path Parameters

end_user_heron_id
string
required

The Heron ID of the end user

Body

application/json

The company and owner details to state for this deal. The response is the same body GET returns, so a caller can read back the result of the write.

business
object | null

The company being underwritten. Only the keys stated are written. A key left out keeps its earlier value.

owners
object[]

Response

OK

Everything the deal's sources found about who the applicant is, with one value for each field and the source it was taken from. When the sources give different values, the value from the highest-ranked source is shown, and the other values are not in this response. Dates use YYYY-MM-DD and amounts are decimal strings.

affiliates
object[]
required

Everyone linked to the applicant or to an owner who is neither of them, in name order. Never the company being underwritten and never a declared owner, which are business and owners, and never someone only a record names, who is in that record's relationships.

arrests
object[]
required

Most recent first.

bankruptcies
object[]
required

Newest filing first.

business
object | null
required

The company being underwritten. Null when no source identified one, which happens on a deal with no application form and no company search.

corporate_filings
object[]
required

Newest incorporation first.

criminal_cases
object[]
required

Newest filing first.

custom_entities
object
required

The fields defined outside the standardised ones, keyed by entity name. A single entity is one object and a list entity is a list of row objects. Each object carries the attribute names as keys with one value each, and _sources names the source type each value was taken from. An attribute no source stated is null and absent from _sources. Empty when no custom entity is defined.

lawsuits
object[]
required

Newest filing first.

liens
object[]
required

Newest filing first.

owners
object[]
required

The owners an application form declared, best attested first, so a reader with room for two sees the two that matter. Empty when no form declared one.

tax_id_verifications
object[]
required

Every identifier an authority was asked to check, with the name it was checked against and the answer, in identifier order.