Validating inputs with Demyst Types
About this guide
This guide describes the various input types that Demyst accepts and sends forward to providers.
Required formats are as follows:
| Data Type | Description | Base Type | Example |
|---|---|---|---|
| abn | 11-digit Australian Business Number | Number | 11 223 344 556 or 1122344556 |
| address | A full address with enough location identifiers to parse a valid address. With or without a country. | String | 28 W 25th St. Floor 9 10010 |
| blob | Base64-encoded binary data | String | RGVteXN0 |
| boolean | True/False indicator. Generic, free-form type | Boolean or String | true, False, y, N, 0, 1, .. |
| business_name | The name of a company | String | Demyst Data Ltd. |
| city | The name of a city | String | New York City |
| country | Must be a 2-character or 3-character iso code. | String | US, AU, SG |
| date | 8-digit date with format CCYY-MM-DD | ISO 8601 | 12/31/16 |
| date_of_birth | 8-digit (CCYY-MM-DD), 6-digit (CCYY-MM), or 4-digit (CCYY) date of birth | ISO 8601 | 2016-12-31, 2016-12, 2016 |
| date_time | Full timestamp or 8-digit (CCYY-MM-DD) date | ISO 8601 | 2016-12-31T06:21:40Z or 2016-12-31 |
| domain | An internet domain name | String | demyst.com |
| email_address | An email address | String | [email protected] |
| first_name | A first name | String | John |
| full_name | A full name | String | John Rupert Doe |
| gender | A gender or abbreviation | String | m, male, f, female |
| ip4 | IP address, version 4 (32-bit address). Must contain 4 octets between 0 and 255, and 3 periods | Numbers | 192.168.0.1 |
| ip6 | IP address, version 6 (128-bit hexadecimal address). Must have 8 segments between 0 and FFFF, and 7 colons | String | 3ffe:1900:fe21:4545:0000:0000:0000:0000 |
| last_name | A last name | String | Smith |
| latitude | A number between -90.0–90.0 | Number | 40.7 |
| longitude | A number between -180.0–180.0 | Number | -73.9 |
| marital_status | A marital status or abbreviation | String | m, married, s, single, ... |
| middle_name | A middle name | String | Rupert |
| month_day | A day of a month.4-digits with format MM-DD | ISO 8601:2000 | 31-Dec |
| naics_code | A North American Industry Classification System code. 5 or 6-digit numeric industry code | Number | 11100 |
| number | Positive or negative number. Supports integral and decimal numbers of arbitrary size and precision. Generic, free-form type | Number | -42, 0.5, 2.0000057301 |
| percentage | A number between -100.0 and 100.0 (negative numbers would imply a percent difference) | Number | 99%, 99 |
| phone | Country dependent. For the US: must be 10 numeric digits without leading "1" or 11 digits with, and the area code must be valid. Dashes stripped during validation | Number | 917-475-1881 |
| post_code | If US: 5 or 9-digit postal code, dash or no dash separating. Other countries need to be non-empty. Certain countries must be alphanumeric | String | 10001 |
| post_code_extension | 4-digit (or less) postal code extension | Number | 4863 |
| sic_code | A Standard Industrial Classification code. 4-digit numerical industry code | Number | 2024 |
| state | If US: it must be a valid 2-character state code or state name. Empty otherwise | Number | NY, New York |
| street | Non-empty. A street name | String | 100 Main St |
| string | A character string. Generic, free-form type | String | foo |
| updated_at | Full timestamp or 8-digit date for when the object was last updated | ISO 8601 | 2016-12-31T06:21:40Z or 2016-12-31 |
| url | A Uniform Resource Locator. Starts with http: or https: | String | https://demyst.com/ |
| us_ein | (Only US) An Employer Identification Number. Dashes and spaces stripped from input by the US and must be 9 numeric character string | Number | 12-3456789 |
| us_ssn | (Only US) A Social Security Number. Dashes and spaces stripped from input by the US and must be 9 numeric character string | Number | 078-05-1120 |
| us_ssn4 | (Only US) The last four digits of a Social Security Number | String | 1120 |
| vin | 17-digit alpha-numeric Vehicle Identification Number | String | 1Z2YX34567W890123 |
| year_month | A particular month of the year. 6-digits with format CCYY-MM | ISO 8601 | 2019-01 |
| year | A year. 4-digits with format CCYY | ISO 8601 | 2019 |
Updated 9 months ago