tastytrade · Schema
Customer
Customer model
FinanceBrokerageTradingOptionsFuturesEquitiesCryptoMarket DataWebSocket
Properties
| Name | Type | Description |
|---|---|---|
| id | string | |
| first-name | string | |
| first-surname | string | |
| last-name | string | |
| middle-name | string | |
| prefix-name | string | |
| second-surname | string | |
| suffix-name | string | |
| address | object | |
| customer-suitability | object | |
| mailing-address | object | |
| is-foreign | string | |
| regulatory-domain | string | |
| usa-citizenship-type | string | |
| home-phone-number | string | |
| home-phone-number-details | string | |
| mobile-phone-number | string | |
| mobile-phone-number-details | string | |
| work-phone-number | string | |
| work-phone-number-details | string | |
| birth-date | string | |
| string | ||
| external-id | string | |
| foreign-tax-number | string | |
| tax-number | string | |
| tax-number-type | string | |
| birth-country | string | |
| citizenship-country | string | |
| visa-expiration-date | string | |
| visa-type | string | |
| agreed-to-margining | boolean | |
| subject-to-tax-withholding | boolean | |
| agreed-to-terms | boolean | |
| signature-of-agreement | boolean | |
| desk-customer-id | string | |
| ext-crm-id | string | |
| family-member-names | string | |
| gender | string | |
| has-industry-affiliation | boolean | |
| has-institutional-assets | string | |
| has-listed-affiliation | boolean | |
| has-political-affiliation | boolean | |
| industry-affiliation-firm | string | |
| is-investment-adviser | string | |
| listed-affiliation-symbol | string | |
| political-organization | string | |
| user-id | string | |
| has-delayed-quotes | boolean | |
| has-pending-or-approved-application | string | |
| is-professional | boolean | |
| permitted-account-types | string | |
| created-at | string | |
| entity | object | |
| identifiable-type | string | |
| person | object |
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://developer.tastytrade.com/schemas/accounts-and-customers/Customer",
"title": "Customer",
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"first-name": {
"description": "",
"type": "string"
},
"first-surname": {
"description": "",
"type": "string"
},
"last-name": {
"description": "",
"type": "string"
},
"middle-name": {
"description": "",
"type": "string"
},
"prefix-name": {
"description": "",
"type": "string"
},
"second-surname": {
"description": "",
"type": "string"
},
"suffix-name": {
"description": "",
"type": "string"
},
"address": {
"type": "object",
"properties": {
"city": {
"description": "",
"type": "string"
},
"country": {
"description": "",
"type": "string"
},
"is-domestic": {
"description": "",
"type": "string"
},
"is-foreign": {
"description": "",
"type": "string"
},
"postal-code": {
"description": "",
"type": "string"
},
"state-region": {
"description": "",
"type": "string"
},
"street-one": {
"description": "",
"type": "string"
},
"street-three": {
"description": "",
"type": "string"
},
"street-two": {
"description": "",
"type": "string"
}
},
"description": ""
},
"customer-suitability": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"annual-net-income": {
"description": "",
"type": "integer",
"format": "int32"
},
"covered-options-trading-experience": {
"description": "",
"type": "string"
},
"customer-id": {
"description": "",
"type": "integer",
"format": "int32"
},
"employer-name": {
"description": "",
"type": "string"
},
"employment-status": {
"description": "",
"type": "string"
},
"futures-trading-experience": {
"description": "",
"type": "string"
},
"job-title": {
"description": "",
"type": "string"
},
"liquid-net-worth": {
"description": "",
"type": "integer",
"format": "int32"
},
"marital-status": {
"description": "",
"type": "string"
},
"net-worth": {
"description": "",
"type": "integer",
"format": "int32"
},
"number-of-dependents": {
"description": "",
"type": "integer",
"format": "int32"
},
"occupation": {
"description": "",
"type": "string"
},
"stock-trading-experience": {
"description": "",
"type": "string"
},
"tax-bracket": {
"description": "",
"type": "string"
},
"uncovered-options-trading-experience": {
"description": "",
"type": "string"
}
},
"description": ""
},
"mailing-address": {
"type": "object",
"properties": {
"city": {
"description": "",
"type": "string"
},
"country": {
"description": "",
"type": "string"
},
"is-domestic": {
"description": "",
"type": "string"
},
"is-foreign": {
"description": "",
"type": "string"
},
"postal-code": {
"description": "",
"type": "string"
},
"state-region": {
"description": "",
"type": "string"
},
"street-one": {
"description": "",
"type": "string"
},
"street-three": {
"description": "",
"type": "string"
},
"street-two": {
"description": "",
"type": "string"
}
},
"description": ""
},
"is-foreign": {
"description": "",
"type": "string"
},
"regulatory-domain": {
"description": "",
"type": "string"
},
"usa-citizenship-type": {
"description": "",
"type": "string"
},
"home-phone-number": {
"description": "",
"type": "string"
},
"home-phone-number-details": {
"description": "",
"type": "string"
},
"mobile-phone-number": {
"description": "",
"type": "string"
},
"mobile-phone-number-details": {
"description": "",
"type": "string"
},
"work-phone-number": {
"description": "",
"type": "string"
},
"work-phone-number-details": {
"description": "",
"type": "string"
},
"birth-date": {
"description": "",
"type": "string"
},
"email": {
"description": "",
"type": "string"
},
"external-id": {
"description": "",
"type": "string"
},
"foreign-tax-number": {
"description": "",
"type": "string"
},
"tax-number": {
"description": "",
"type": "string"
},
"tax-number-type": {
"description": "",
"type": "string"
},
"birth-country": {
"description": "",
"type": "string"
},
"citizenship-country": {
"description": "",
"type": "string"
},
"visa-expiration-date": {
"description": "",
"type": "string"
},
"visa-type": {
"description": "",
"type": "string"
},
"agreed-to-margining": {
"description": "",
"type": "boolean"
},
"subject-to-tax-withholding": {
"description": "",
"type": "boolean"
},
"agreed-to-terms": {
"description": "",
"type": "boolean"
},
"signature-of-agreement": {
"description": "",
"type": "boolean"
},
"desk-customer-id": {
"description": "",
"type": "string"
},
"ext-crm-id": {
"description": "",
"type": "string"
},
"family-member-names": {
"description": "",
"type": "string"
},
"gender": {
"description": "",
"type": "string"
},
"has-industry-affiliation": {
"description": "",
"type": "boolean"
},
"has-institutional-assets": {
"description": "",
"type": "string"
},
"has-listed-affiliation": {
"description": "",
"type": "boolean"
},
"has-political-affiliation": {
"description": "",
"type": "boolean"
},
"industry-affiliation-firm": {
"description": "",
"type": "string"
},
"is-investment-adviser": {
"description": "",
"type": "string"
},
"listed-affiliation-symbol": {
"description": "",
"type": "string"
},
"political-organization": {
"description": "",
"type": "string"
},
"user-id": {
"description": "",
"type": "string"
},
"has-delayed-quotes": {
"description": "",
"type": "boolean"
},
"has-pending-or-approved-application": {
"description": "",
"type": "string"
},
"is-professional": {
"description": "",
"type": "boolean"
},
"permitted-account-types": {
"description": "",
"type": "string"
},
"created-at": {
"description": "",
"type": "string",
"format": "date-time"
},
"entity": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"address": {
"type": "object",
"properties": {
"city": {
"description": "",
"type": "string"
},
"country": {
"description": "",
"type": "string"
},
"is-domestic": {
"description": "",
"type": "string"
},
"is-foreign": {
"description": "",
"type": "string"
},
"postal-code": {
"description": "",
"type": "string"
},
"state-region": {
"description": "",
"type": "string"
},
"street-one": {
"description": "",
"type": "string"
},
"street-three": {
"description": "",
"type": "string"
},
"street-two": {
"description": "",
"type": "string"
}
},
"description": ""
},
"business-nature": {
"description": "",
"type": "string"
},
"date-of-trust-creation": {
"description": "",
"type": "string"
},
"email": {
"description": "",
"type": "string"
},
"entity-officers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"external-id": {
"description": "",
"type": "string"
},
"first-name": {
"description": "",
"type": "string"
},
"last-name": {
"description": "",
"type": "string"
},
"middle-name": {
"description": "",
"type": "string"
},
"prefix-name": {
"description": "",
"type": "string"
},
"suffix-name": {
"description": "",
"type": "string"
},
"address": {
"type": "object",
"properties": {
"city": {
"description": "",
"type": "string"
},
"country": {
"description": "",
"type": "string"
},
"is-domestic": {
"description": "",
"type": "string"
},
"is-foreign": {
"description": "",
"type": "string"
},
"postal-code": {
"description": "",
"type": "string"
},
"state-region": {
"description": "",
"type": "string"
},
"street-one": {
"description": "",
"type": "string"
},
"street-three": {
"description": "",
"type": "string"
},
"street-two": {
"description": "",
"type": "string"
}
},
"description": ""
},
"birth-country": {
"description": "",
"type": "string"
},
"birth-date": {
"description": "",
"type": "string",
"format": "date"
},
"citizenship-country": {
"description": "",
"type": "string"
},
"email": {
"description": "",
"type": "string"
},
"employer-name": {
"description": "",
"type": "string"
},
"employment-status": {
"description": "",
"type": "string"
},
"home-phone-number": {
"description": "",
"type": "string"
},
"is-foreign": {
"description": "",
"type": "string"
},
"job-title": {
"description": "",
"type": "string"
},
"marital-status": {
"description": "",
"type": "string"
},
"mobile-phone-number": {
"description": "",
"type": "string"
},
"number-of-dependents": {
"description": "",
"type": "string"
},
"occupation": {
"description": "",
"type": "string"
},
"owner-of-record": {
"description": "",
"type": "boolean"
},
"relationship-to-entity": {
"description": "",
"type": "string"
},
"tax-number": {
"description": "",
"type": "string"
},
"tax-number-type": {
"description": "",
"type": "string"
},
"usa-citizenship-type": {
"description": "",
"type": "string"
},
"visa-expiration-date": {
"description": "",
"type": "string",
"format": "date"
},
"visa-type": {
"description": "",
"type": "string"
},
"work-phone-number": {
"description": "",
"type": "string"
}
},
"description": ""
}
},
"entity-suitability": {
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"annual-net-income": {
"description": "",
"type": "integer",
"format": "int32"
},
"covered-options-trading-experience": {
"description": "",
"type": "string"
},
"entity-id": {
"description": "",
"type": "integer",
"format": "int32"
},
"futures-trading-experience": {
"description": "",
"type": "string"
},
"liquid-net-worth": {
"description": "",
"type": "integer",
"format": "int32"
},
"net-worth": {
"description": "",
"type": "integer",
"format": "int32"
},
"stock-trading-experience": {
"description": "",
"type": "string"
},
"tax-bracket": {
"description": "",
"type": "string"
},
"uncovered-options-trading-experience": {
"description": "",
"type": "string"
}
},
"description": ""
},
"entity-type": {
"description": "",
"type": "string"
},
"foreign-institution": {
"description": "",
"type": "string"
},
"grantor-birth-date": {
"description": "",
"type": "string"
},
"grantor-email": {
"description": "",
"type": "string"
},
"grantor-first-name": {
"description": "",
"type": "string"
},
"grantor-last-name": {
"description": "",
"type": "string"
},
"grantor-middle-name": {
"description": "",
"type": "string"
},
"grantor-tax-number": {
"description": "",
"type": "string"
},
"has-foreign-bank-affiliation": {
"description": "",
"type": "string"
},
"has-foreign-institution-affiliation": {
"description": "",
"type": "string"
},
"is-domestic": {
"description": "",
"type": "string"
},
"legal-name": {
"description": "",
"type": "string"
},
"mailing-address": {
"type": "object",
"properties": {
"city": {
"description": "",
"type": "string"
},
"country": {
"description": "",
"type": "string"
},
"is-domestic": {
"description": "",
"type": "string"
},
"is-foreign": {
"description": "",
"type": "string"
},
"postal-code": {
"description": "",
"type": "string"
},
"state-region": {
"description": "",
"type": "string"
},
"street-one": {
"description": "",
"type": "string"
},
"street-three": {
"description": "",
"type": "string"
},
"street-two": {
"description": "",
"type": "string"
}
},
"description": ""
},
"phone-number": {
"description": "",
"type": "string"
},
"secretary-name": {
"description": "",
"type": "string"
},
"tax-election": {
"description": "",
"type": "string"
},
"tax-number": {
"description": "",
"type": "string"
}
},
"description": ""
},
"identifiable-type": {
"description": "",
"type": "string"
},
"person": {
"type": "object",
"properties": {
"external-id": {
"description": "",
"type": "string"
},
"first-name": {
"description": "",
"type": "string"
},
"last-name": {
"description": "",
"type": "string"
},
"middle-name": {
"description": "",
"type": "string"
},
"prefix-name": {
"description": "",
"type": "string"
},
"suffix-name": {
"description": "",
"type": "string"
},
"birth-country": {
"description": "",
"type": "string"
},
"birth-date": {
"description": "",
"type": "string",
"format": "date"
},
"citizenship-country": {
"description": "",
"type": "string"
},
"usa-citizenship-type": {
"description": "",
"type": "string"
},
"visa-expiration-date": {
"description": "",
"type": "string",
"format": "date"
},
"visa-type": {
"description": "",
"type": "string"
},
"employer-name": {
"description": "",
"type": "string"
},
"employment-status": {
"description": "",
"type": "string"
},
"job-title": {
"description": "",
"type": "string"
},
"marital-status": {
"description": "",
"type": "string"
},
"number-of-dependents": {
"description": "",
"type": "string"
},
"occupation": {
"description": "",
"type": "string"
}
},
"description": ""
}
},
"description": "Customer model"
}