Overview

Entity features are input features that represent entities such as person and business.

Sperta understands the schema of entity features and maps their attributes to the inputs of data sources. Each attribute of an entity is optional, but you need to pass in all the attributes required by data sources.

The following entities are supported:

An entity could contain objects, and the following objects are supported:

Person entity

Attribute	Type	Description	Example
first_name	String	A string with a max length of 100 characters.	Jane
last_name	String	A string with a max length of 100 characters.	Smith
middle_name	String	A string with a max length of 100 characters.	Cecily
date_of_birth	String	A date in the format YYYY-MM-DD	1990-01-23
id_number	ID Number	An ID number
email	String	Email address	jane@gmail.com
phone_number	String	A phone number in E.164 format	+14151234567
address	Address	An address

{
    "first_name": "Jane",
    "last_name": "Smith",
    "middle_name": "Cecily",
    "date_of_birth": "1985-01-23",
    "id_number": {
        "type": "US_SSN",
        "value": "123456789"
    },
    "email": "jane@gmail.com",
    "phone_number": "+14151234567",
    "address": {
        "street": "30 Folsom St",
        "street2": "Apt 201",
        "city": "San Francisco",
        "subdivision": "CA",
        "postal_code": "94105",
        "country_code": "US"
    }
}

An example Person entity in JSON

Business entity

Attribute	Type	Description	Example
name	String	A string with a max length of 100 characters.	Acme Inc.
id_number	ID Number	An ID number
email	String	Email address	hi@acme.com
phone_number	String	A phone number in E.164 format	+14151234567
website	String	The URL of the website	https://www.acme.com
address	Address	An address

{
    "name": "Acme Inc.",
    "id_number": {
        "type": "US_EIN",
        "value": "873456789"
    },
    "email": "hi@acme.com",
    "phone_number": "+14151234567",
    "website": "https://www.acme.com",
    "address": {
        "street": "300 Folsom St",
        "street2": "",
        "city": "San Francisco",
        "subdivision": "CA",
        "postal_code": "94105",
        "country_code": "US"
    }
}

An example Business entity in JSON

ID number object

The IdNumber object represents individual and business IDs in different countries.

ID Numbers should be stripped of any formatting characters like spaces, periods, and dashes.

Attribute	Type	Description	Example
type	String	A globally unique and human readable ID type, specific to the country and document category.	US_SSN
value	String	Value of identity document value. Alpha-numeric, with all formatting characters stripped.	123456789

The following ID types are supported by Sperta:

API Type	Country	Entity	Name
BR_CNPJ	Brazil	Business	Cadastro Nacional da Pessoa Jurídica (CNPJ)
BR_CPF	Brazil	Person	Cadastro de Pessoas Físicas (CPF)
US_EIN	United States	Business	Employer Identification Number (EIN)
US_SSN	United States	Person	Social Security Number (SSN)

Address object

Attribute	Type	Description	Example
street	String	The primary street portion of an address.	30 Folsom St
street2	String	Extra street information, like an apartment or suite number.	Apt 201
city	String	City or town	San Francisco
subdivision	String	Highest administrative subdivision which is used for postal addresses of a country. Related terms would be "state", "province", "region", etc. Leave this field empty if the country doesn't use a subdivision in postal addresses. Use a code in certain countries, e.g. CA for California in the U.S.	CA
postal_code	String	The postal code for the associated address. Between 2 and 10 alphanumeric characters.	94105
country_code	String	Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.	US