Plaid Account Owners
27 removals
223 lines
27 additions
223 lines
"""
"""
Plaid Account Identity data.
Plaid Account Owners data.
"""
"""
type PlaidAccountIdentity {
type RemoteDataPlaidAccountIdentity {
"""
"""
Plaid’s unique identifier for the account. This value will not change unless
Plaid’s unique identifier for the account. This value will not change unless
Plaid can't reconcile the account with the data returned by the financial
Plaid can't reconcile the account with the data returned by the financial
institution. This may occur, for example, when the name of the account
institution. This may occur, for example, when the name of the account
changes. If this happens a new `account_id` will be assigned to the account.
changes. If this happens a new `account_id` will be assigned to the account.
The `account_id` can also change if the `access_token` is deleted and the same
The `account_id` can also change if the `access_token` is deleted and the same
credentials that were used to generate that `access_token` are used to
credentials that were used to generate that `access_token` are used to
generate a new `access_token` on a later date. In that case, the new
generate a new `access_token` on a later date. In that case, the new
`account_id` will be different from the old `account_id`.
`account_id` will be different from the old `account_id`.
If an account with a specific `account_id` disappears instead of changing, the
If an account with a specific `account_id` disappears instead of changing, the
account is likely closed. Closed accounts are not returned by the Plaid API.
account is likely closed. Closed accounts are not returned by the Plaid API.
Like all Plaid identifiers, the `account_id` is case sensitive.
Like all Plaid identifiers, the `account_id` is case sensitive.
"""
"""
accountId: String!
accountId: String
"""
"""
A set of fields describing the balance for an account. Balance information may
A set of fields describing the balance for an account. Balance information may
be cached unless the balance object was returned by `/accounts/balance/get`.
be cached unless the balance object was returned by `/accounts/balance/get`.
"""
"""
balances: PlaidAccountBalance!
balances: RemoteDataPlaidAccountBalance
"""
"""
The last 2-4 alphanumeric characters of an account's official account number.
The last 2-4 alphanumeric characters of an account's official account number.
Note that the mask may be non-unique between an Item's accounts, and it may
Note that the mask may be non-unique between an Item's accounts, and it may
also not match the mask that the bank displays to the user.
also not match the mask that the bank displays to the user.
"""
"""
mask: String
mask: String
"""
"""
The name of the account, either assigned by the user or by the financial institution itself
The name of the account, either assigned by the user or by the financial institution itself
"""
"""
name: String!
name: String
"""
"""
The official name of the account as given by the financial institution
The official name of the account as given by the financial institution
"""
"""
officialName: String
officialName: String
"""
"""
Data returned by the financial institution about the account owner or owners.
Data returned by the financial institution about the account owner or owners.
Only returned by Identity or Assets endpoints. For business accounts, the name
Only returned by Identity or Assets endpoints. For business accounts, the name
reported may be either the name of the individual or the name of the business,
reported may be either the name of the individual or the name of the business,
depending on the institution. Multiple owners on a single account will be
depending on the institution. Multiple owners on a single account will be
represented in the same `owner` object, not in multiple owner objects within
represented in the same `owner` object, not in multiple owner objects within
the array. In API versions 2018-05-22 and earlier, the `owners` object is not
the array. In API versions 2018-05-22 and earlier, the `owners` object is not
returned, and instead identity information is returned in the top level
returned, and instead identity information is returned in the top level
`identity` object. For more details, see [Plaid API
`identity` object. For more details, see [Plaid API
versioning](https://plaid.com/docs/api/versioning/#version-2019-05-29)
versioning](https://plaid.com/docs/api/versioning/#version-2019-05-29)
"""
"""
owners: [PlaidOwner!]
owners: [RemoteDataPlaidOwner!]
"""
"""
A unique and persistent identifier for accounts that can be used to trace
A unique and persistent identifier for accounts that can be used to trace
multiple instances of the same account across different Items for depository
multiple instances of the same account across different Items for depository
accounts. This is currently an opt-in field and only supported for Chase Items.
accounts. This is currently an opt-in field and only supported for Chase Items.
"""
"""
persistentAccountId: String
persistentAccountId: String
"""
"""
See the [Account type
See the [Account type
schema](https://plaid.com/docs/api/accounts/#account-type-schema) for a full
schema](https://plaid.com/docs/api/accounts/#account-type-schema) for a full
listing of account types and corresponding subtypes.
listing of account types and corresponding subtypes.
"""
"""
subtype: String
subtype: String
"""
"""
`investment:` Investment account. In API versions 2018-05-22 and earlier, this type is called `brokerage` instead.
`investment:` Investment account. In API versions 2018-05-22 and earlier, this type is called `brokerage` instead.
`credit:` Credit card
`credit:` Credit card
`depository:` Depository account
`depository:` Depository account
`loan:` Loan account
`loan:` Loan account
`other:` Non-specified account type
`other:` Non-specified account type
See the [Account type
See the [Account type
schema](https://plaid.com/docs/api/accounts#account-type-schema) for a full
schema](https://plaid.com/docs/api/accounts#account-type-schema) for a full
listing of account types and corresponding subtypes.
listing of account types and corresponding subtypes.
"""
"""
type: String!
type: String
"""
"""
The current verification status of an Auth Item initiated through Automated or
The current verification status of an Auth Item initiated through Automated or
Manual micro-deposits. Returned for Auth Items only.
Manual micro-deposits. Returned for Auth Items only.
`pending_automatic_verification`: The Item is pending automatic verification
`pending_automatic_verification`: The Item is pending automatic verification
`pending_manual_verification`: The Item is pending manual micro-deposit
`pending_manual_verification`: The Item is pending manual micro-deposit
verification. Items remain in this state until the user successfully verifies
verification. Items remain in this state until the user successfully verifies
the two amounts.
the two amounts.
`automatically_verified`: The Item has successfully been automatically verified
`automatically_verified`: The Item has successfully been automatically verified
`manually_verified`: The Item has successfully been manually verified
`manually_verified`: The Item has successfully been manually verified
`verification_expired`: Plaid was unable to automatically verify the deposit
`verification_expired`: Plaid was unable to automatically verify the deposit
within 7 calendar days and will no longer attempt to validate the Item. Users
within 7 calendar days and will no longer attempt to validate the Item. Users
may retry by submitting their information again through Link.
may retry by submitting their information again through Link.
`verification_failed`: The Item failed manual micro-deposit verification
`verification_failed`: The Item failed manual micro-deposit verification
because the user exhausted all 3 verification attempts. Users may retry by
because the user exhausted all 3 verification attempts. Users may retry by
submitting their information again through Link.
submitting their information again through Link.
"""
"""
verificationStatus: String
verificationStatus: String
}
}
"""
"""
A physical mailing address.
A physical mailing address.
"""
"""
type PlaidAddress {
type RemoteDataPlaidAddress {
"""
"""
Data about the components comprising an address.
Data about the components comprising an address.
"""
"""
data: PlaidAddressData!
data: RemoteDataPlaidAddressData
"""
"""
When `true`, identifies the address as the primary address on an account.
When `true`, identifies the address as the primary address on an account.
"""
"""
primary: Boolean!
primary: Boolean
}
}
"""
"""
Data about the components comprising an address.
Data about the components comprising an address.
"""
"""
type PlaidAddressData {
type RemoteDataPlaidAddressData {
"""
"""
The full city name
The full city name
"""
"""
city: String
city: String
"""
"""
The ISO 3166-1 alpha-2 country code
The ISO 3166-1 alpha-2 country code
"""
"""
country: String
country: String
"""
"""
The postal code. In API versions 2018-05-22 and earlier, this field is called `zip`.
The postal code. In API versions 2018-05-22 and earlier, this field is called `zip`.
"""
"""
postalCode: String
postalCode: String
"""
"""
The region or state. In API versions 2018-05-22 and earlier, this field is called `state`.
The region or state. In API versions 2018-05-22 and earlier, this field is called `state`.
Example: `"NC"`
Example: `"NC"`
"""
"""
region: String
region: String
"""
"""
The full street address
The full street address
Example: `"564 Main Street, APT 15"`
Example: `"564 Main Street, APT 15"`
"""
"""
street: String!
street: String
}
}
"""
"""
An object representing an email address
An object representing an email address
"""
"""
type PlaidEmail {
type RemoteDataPlaidEmail {
"""
"""
The email address.
The email address.
"""
"""
data: String!
data: String
"""
"""
When `true`, identifies the email address as the primary email on an account.
When `true`, identifies the email address as the primary email on an account.
"""
"""
primary: Boolean!
primary: Boolean
"""
"""
The type of email account as described by the financial institution.
The type of email account as described by the financial institution.
"""
"""
type: String!
type: String
}
}
"""
"""
Data returned from the financial institution about the owner or owners of an
Data returned from the financial institution about the owner or owners of an
account. Only the `names` array must be non-empty.
account. Only the `names` array must be non-empty.
"""
"""
type PlaidOwner {
type RemoteDataPlaidOwner {
"""
"""
Data about the various addresses associated with the account by the financial
Data about the various addresses associated with the account by the financial
institution. May be an empty array if no relevant information is returned from
institution. May be an empty array if no relevant information is returned from
the financial institution.
the financial institution.
"""
"""
addresses: [PlaidAddress!]!
addresses: [RemoteDataPlaidAddress!]
"""
"""
A list of email addresses associated with the account by the financial
A list of email addresses associated with the account by the financial
institution. May be an empty array if no relevant information is returned from
institution. May be an empty array if no relevant information is returned from
the financial institution.
the financial institution.
"""
"""
emails: [PlaidEmail!]!
emails: [RemoteDataPlaidEmail!]
"""
"""
A list of names associated with the account by the financial institution. In
A list of names associated with the account by the financial institution. In
the case of a joint account, Plaid will make a best effort to report the names
the case of a joint account, Plaid will make a best effort to report the names
of all account holders.
of all account holders.
If an Item contains multiple accounts with different owner names, some
If an Item contains multiple accounts with different owner names, some
institutions will report all names associated with the Item in each account's `names` array.
institutions will report all names associated with the Item in each account's `names` array.
"""
"""
names: [String!]!
names: [String!]
"""
"""
A list of phone numbers associated with the account by the financial
A list of phone numbers associated with the account by the financial
institution. May be an empty array if no relevant information is returned from
institution. May be an empty array if no relevant information is returned from
the financial institution.
the financial institution.
"""
"""
phoneNumbers: [PlaidPhoneNumber!]!
phoneNumbers: [RemoteDataPlaidPhoneNumber!]
}
}
"""
"""
A phone number
A phone number
"""
"""
type PlaidPhoneNumber {
type RemoteDataPlaidPhoneNumber {
"""
"""
The phone number.
The phone number.
"""
"""
data: String!
data: String
"""
"""
When `true`, identifies the phone number as the primary number on an account.
When `true`, identifies the phone number as the primary number on an account.
"""
"""
primary: Boolean!
primary: Boolean
"""
"""
The type of phone number.
The type of phone number.
"""
"""
type: String!
type: String
}
}