Params

Param name Description
id
required

entity ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

Entity information

Validations:

  • Must be a Hash

data[type]
optional

Validations:

data[attributes]
optional

Validations:

  • Must be a Hash

data[attributes][short-name]
optional

Validations:

  • Must be a String

data[attributes][pretty-name]
optional

Validations:

  • Must be a String

data[attributes][entity-description]
optional , nil allowed

Validations:

  • Must be a String

data[attributes][logo]
optional , nil allowed

Entity's logo file in data URL format

Validations:

  • Must be a String

data[attributes][logo-file-name]
optional , nil allowed

Entity's logo file name

Validations:

  • Must be a String

data[attributes][country]
optional

Validations:

  • Must be a String

data[attributes][contact-info]
optional , nil allowed

Entity's contact information

Validations:

  • Must be a Hash

data[attributes][contact-info][email]
optional , nil allowed

Official email of the entity

Validations:

  • Must be a String

data[attributes][contact-info][website]
optional , nil allowed

Official website of the entity

Validations:

  • Must be a String

data[attributes][contact-info][street-address]
optional , nil allowed

The street address of the entity

Validations:

  • Must be a String

data[attributes][contact-info][postal-code]
optional , nil allowed

The postal code of the entity

Validations:

  • Must be a String

data[attributes][contact-info][city]
optional , nil allowed

The city of the entity

Validations:

  • Must be a String

data[attributes][contact-info][phone-number]
optional , nil allowed

The phone number of the entity

Validations:

  • Must be a String

data[attributes][country-of-primary-listing]
optional , nil allowed

Validations:

  • Must be a String

data[attributes][investor-relation-info]
optional , nil allowed

Entity's investor relation information

Validations:

  • Must be a Hash

data[attributes][investor-relation-info][ir-email]
optional , nil allowed

Official email of the entity IR

Validations:

  • Must be a String

data[attributes][investor-relation-info][ir-website]
optional , nil allowed

Official website of the entity IR

Validations:

  • Must be a String

data[attributes][investor-relation-info][ir-info]
optional , nil allowed

Official information of the entity IR

Validations:

  • Must be a String