Instruments

When you create or edit an instrument, the fields below are either optional or required.

instrument

Field

Description

Examples

instrument_id

Unique identifier of the instrument in your system

  • 123456789

instrument_type

Type of instrument

  • bank
  • credit_card

source

Internal if your system owns and administers this instrument, otherwise External.

  • internal
  • external

status

Status of the instrument in your system

  • active

registered_at

Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)

  • 1632776052

parent_instrument_id

The unique identifier for an instrument, which is the parent of the this instrument in your system, as defined by you

  • 454543-rtdgdf

tags

Additional information that can be used for grouping and filtering in "key:value" format

  • sector:Europe
  • source:UK_internal

location_data

Field

Description

Examples

type

A field indicating the type of location

  • shipping
  • Building

building_number

Building number of the location

  • 1800

unit_number

Flat/apartment/suite number of the building

  • 2

street_name

Street name of the location

  • Girard Ave

city

City of the location

  • San Francisco

state

State or region for the location. For the U.S., use the two character state code. For non-U.S., use the ISO 3166-2 standard

  • US

postal_code

Postal code of the location

  • 94134

country

Country of the location - use the ISO 3166-1 standard

  • US

digital_data.ip_address

Field

Description

Examples

ip_address

List of IP addresses. MUST be in either IPv4 or IPv6 format.

  • 52.15.247.208

first_seen

Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)

  • 1572643220

last_seen

Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)

  • 1572643225

digital_data.client_fingerprint

Field

Description

Examples

fingerprint

Fingerprints associated with this instrument

  • 3k2kj2jk23kj2343

first_seen

Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)

  • 1572643226

last_seen

Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)

  • 1572643240

custom_data

Field

Description

Examples

custom_data

Any additional information that should be associated with this instrument in key:value format

  • Reviewed by: John Smith
  • Region: 3

Did this page help you?