Common Data Models
Address
Special Characters
The following special characters are allowed in the Street attribute for addresses: - # /
U.S. or Canadian Address
- Schema
 - Example
 
| Attributes | Required | Data Type | Max Length | 
|---|---|---|---|
Country | ✔️ | Countries | 2 | 
Street | ✔️ | String | 30 | 
City | ✔️ | String | 30 | 
StateProvince | ✔️ | US States  CanadianProvinces  | 2 | 
PostalCode | ✔️ | String | 10 | 
{
  "country": "US",
  "street": "2 Perimeter Park S Suite 100W",
  "city": "Birmingham",
  "stateProvince": "AL",
  "postalCode": "35243"
}
Foreign Address
- Schema
 - Example
 
| Attributes | Required | Data Type | Max Length | 
|---|---|---|---|
Country | ✔️ | Countries | |
Street | ✔️ | String | 30 | 
City | ✔️ | String | 30 | 
PostalCode | String | 10 | 
{
    "country": "AR",
    "street": "Sarmiento 459, 9no piso y 10mo piso",
    "city": "Capital Federal"
    "postalCode": "CI041AAI"
}
Affiliation
Requirements
- If the 
Associated = Truefor any affiliations object, then all the remaining attributes of that object are required 
- Schema
 - Example
 
| Attributes | Data Type | 
|---|---|
Industry | Industry Affiliation | 
Political | Political Affiliation | 
PublicCompany | Public Company Affiliation | 
StoneX | StoneX Affiliation | 
{
  "political": {
    "Associated": true,
    "name": "John Doe",
    "organization": "Example Political Organization",
    "relationship": "Self"
  },
  "Industry": {
    "Associated": true,
    "FirmClearing": false,
    "companyName": "Stonex"
  },
  "PublicCompany": {
    "Associated": true,
    "name": "StoneX",
    "symbol": "SNEX"
  },
  "Stonex": {
    "Associated": true,
    "name": "John Doe",
    "position": "Manager",
    "relationship": "Self",
    "affiliatedEntity": "STNX"
  }
}
Industry Affiliation
| Attributes | Data Type | 
|---|---|
Associated | Boolean | 
FirmClearing | Boolean | 
CompanyName | String | 
Political Affiliation
| Attributes | Data Type | 
|---|---|
Associated | Boolean | 
FirstName | String | 
LastName | String | 
Organization | String | 
Relationship | String | 
Public Company Affiliation
| Attributes | Data Type | 
|---|---|
Associated | Boolean | 
Name | String | 
Symbol | String | 
StoneX Affiliation
| Attributes | Data Type | 
|---|---|
Associated | Boolean | 
FirstName | String | 
LastName | String | 
Position | String | 
Relationship | String | 
AffiliatedEntity | Affiliated Entity | 
Government Identification
Requirements
GovernmentId1is required for non-US Citizens- For non-US Citizens 
GovernmentId1isNationalID - The value of 
GovernmentId1is used for CAIS Reporting 
- Schema
 - Example
 
| Attributes | Data Type | 
|---|---|
GovernmentId1 | Government ID Details | 
GovernmentId2 | Government ID Details | 
{
    "governmentId1": {
        "idType": "NationalID",
        "idNumber": "252131315131",
        "idLocation": "AR",
        "idIssueDate": "2020-01-01",
        "idExpirationDate": ""
    },
    "governmentId2": {
        "delete": "*",
        "idType": "passport",
        "idNumber": "E00007734",
        "idCountry": "US",
        "idIssueDate": "2020-01-01",
        "idExpiration": "2030-01-01"
    }
}
Government ID Details
| Attributes | Required | Data Type | Max Length | 
|---|---|---|---|
IdType | ✔️ | Government ID Types | 2 | 
IdNumber | ✔️ | String | 25 | 
IdLocation | ✔️ | Countries | 2 | 
IdIssueDate | Date Format | ||
IdExpirationDate | Date Format | 
Trusted Contact
- Schema
 - Example
 
| Attributes | Required | Data Type | Max Length | 
|---|---|---|---|
DeclineDate | Date Format | ||
Name | ✔️ | String | 30 | 
Relationship | ✔️ | RelationshipTypes | |
PhoneRegionCode | ✔️ | Phone Region Codes | |
PhoneNumber | ✔️ | String | 15 | 
Email | ✔️ | String | 50 | 
Address | Address | 
{
  "name": "Jane Smith",
  "relationship": "spouse",
  "phoneRegionCode": "1",
  "phoneNumber": "2056786578",
  "email": "jane.smith@example.com",
  "address": {
    "street": "2 Perimeter Park S Suite 100W",
    "city": "Birmingham",
    "stateProvince": "AL",
    "country": "US",
    "postalCode": "35243"
  }
}
Trusted Contact Requirements
If no trusted contact is being added to the account, provide the decline date only. No other attributes are required.