Entity

openapi: 3.0.3 info: title: Entity Services version: v1 description: Services related to an Entity and it's Relationships. contact: name: Entity Services url: 'https://www.jackhenry.com/' email: DC-Operations@jackhenry.com servers: - url: 'http://jx-r.jhacorp.com' description: This is the URL for the corporate test server. tags: - name: Entities description: Entity is a representation of any legal identity. - name: Addresses description: Addresses for an Entity. - name: Phone Numbers description: Phone Numbers for an Entity. - name: Digital Contact Points description: Digital Contact Points for an Entity. - name: Identifications description: Forms of Identification for an Entity. - name: Privacy Opt Outs description: Privacy Opt Out choices for an Entity. - name: Affiliate Opt Outs description: Affiliate Opt Out choices for an Entity. - name: Employments description: Employments for an Entity. - name: Tax Id Number description: The Entity's Tax Id Number - name: Foreign Tax Id Number description: The Entity's Foreign Tax Id Number - name: Reports description: Generate and download reports for Entities. - name: Notices description: Generate and download Notices for Entities. - name: Abilities description: Retrieve user specific Abilities for Entity Services. - name: Entitlements description: Retrieve user specific Entitlements for Entity Services. - name: Relationships description: >- A Relationships describes an Entity-to-Entity association regarding a specific asset. - name: Relationship Types description: The types of Relationships allowed by an Institution. - name: Address Labels description: Address Labels allowed by an Institution. - name: Affiliate Opt Out Exception Reasons description: Affiliate Opt Out Exception Reasons allowed by an Institution. - name: Affiliate Opt Out Types description: Affiliate Opt Out Types allowed by an Institution. - name: Digital Contact Point Labels description: Digital Contact Point Labels allowed by an Institution. - name: Disabilities description: Disabilities allowed by an Institution. - name: Entity Settings description: Entity Setting configuration for an Institution. - name: Entity Sub Types description: Entity Sub Types allowed by an Institution. - name: Ethnicities description: Ethnicities allowed by an Institution. - name: Genders description: Genders allowed by an Institution. - name: Identification Types description: Identification Types allowed by an Institution. - name: Income Levels description: Income Levels allowed by an Institution. - name: Insider Roles description: Insider Roles allowed by an Institution. - name: Legal Entity Exclusion Reasons description: Legal Entity Exclusion Reasons allowed by an Institution. - name: Phone Labels description: Phone Labels allowed by an Institution. - name: Phone Settings description: Phone Settings configurations for an Institution. - name: Pronouns description: Pronouns allowed by an Institution. - name: Privacy Opt Out Types description: Privacy Opt Out Types allowed by an Institution. - name: Races description: Races allowed by an Institution. - name: Tax Id Types description: Tax Identification Types allowed by an Institution. - name: Chapter Exemptions description: Chapter Exemptions defined by the IRS. - name: Chapter Statuses description: Chapter Statuses defined by the IRS. - name: W8 Types description: W8 Types defined by the IRS. - name: Settings description: Get All Settings in one end point. - name: Country Codes description: Countries with ISO 3166 codes. - name: State Codes description: US States with ISO 3166 and FIPS codes. - name: County Codes description: US Counties with FIPS codes. - name: Aggregate Relationship Search description: 'Entity, Relationship, Account, and Balance search' - name: Profile Image Service description: Profile Image Service paths: '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities': post: operationId: createEntity tags: - Entities description: Method to add an Entity resource. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: X-Override-Duplicate-Tax-Id-Number description: >- Indicates whether to override duplicate tax ID number check. Default is false. in: header schema: type: boolean default: false requestBody: description: Entity resource to be created. content: application/json: schema: required: - addresses allOf: - type: object required: - entityType - taxIdType - entitySubtypeId - lastName - taxInformation properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityType: type: string description: | This attribute identifies the entity type. nullable: false enum: - Individual - Nonindividual entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: > If `IsEntitySubtypeMandatory` of `EntitySettings` is true, this property must have an Id value. The entity subtype must also be valid for the entity type based on `EntityTypesApplicable` settings. taxIdType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: > The tax id type must be valid for the entity type based on `EntityTypesApplicable` settings. taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: | Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 suffix: type: string description: >- This attribute defines the suffix that should follow the name of the entity. nullable: true maxLength: 31 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 foreignEntity: type: boolean description: >- This attribute designates whether the entity is a US person/Org or not. nullable: true default: false foreignTaxIdNumber: type: string description: > This attribute specifies the foreign Taxpayer Identification Number used for tax purposes in the country of residence. It will be utilized for 1042-S reporting. Must consist only of alphanumeric characters. maxLength: 25 nullable: true insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false startDate: type: string format: date description: > This attribute defines either the birth date of Individual or the start date of Nonindividual. Must be a current date or past date. nullable: true endDate: type: string format: date description: > This attribute defines either the deceased date of Individual or the end date of Nonindividual. Must be a current date or past date. nullable: true entityOfficerId: type: string format: uuid description: >- This attribute defines the primary officer Id associated to entity's account. nullable: true entityBranchAddressId: type: string format: uuid description: >- This attribute defines the branch Id associated to entity's account. nullable: true natureOfBusiness: type: string description: > This attribute defines the nature of business for the entity. It is a free-form text field that describes the primary business activity of the entity. nullable: true maxLength: 255 taxReturnDate: type: string format: date-time description: | This attribute defines the commercial tax return date. Must be a current date or past date. nullable: true ficoScore: type: string format: numeric only description: > This attribute is the FICO score of the entity. A numerical representation of the credit risk that helps FIs decide whether to approve loans or credit cards. minLength: 3 maxLength: 3 netWorth: description: > This attribute specifies the net worth currency value of the entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false gender: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. pronoun: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. race: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. ethnicity: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. disability: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. incomeLevel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. militaryInformation: allOf: - type: object description: >- The military information associated with this entity. properties: status: type: string description: >- This attribute indicates the military status of this entity. nullable: true enum: - Active Duty - Reserve - Inactive - Dependent activeDutyVerificationDate: type: string format: date description: >- This is the date active duty status was verified. nullable: true activeDutyStartDate: type: string format: date description: >- This date indicates the start date of active duty status. nullable: true activeDutySeparationDate: type: string format: date description: >- This date indicates the separation date from active duty status. nullable: true nullable: true - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true privacyOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Privacy Opt Out options. This value can only be set to true if the Institution's entity settings `AllowPrivacyOptOutAll` value is true. nullable: true default: false privacyActLastNoticeDate: type: string format: date-time description: > The timestamp of when the entity was last notified about the Privacy Act. Must be current date or a past date. nullable: true affiliateOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Affiliate Opt Out options. This value can only be set to true if the Institution's entity settings AllowAffiliateOptOutAll value is true. nullable: true default: false includeLegalEntity: type: boolean description: > This attribute represents the entity's inclusion to the FinCEN Customer Due Diligence (CDD) processes. If the value is set as false, the legal entity exclusion reason must be provided. nullable: true default: false legalEntityExclusionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- The attribute is required when `includeLegalEntity` is set to `false`. legalEntityId: type: string description: >- A unique alphanumeric identifier for legal entities participating in financial transactions. nullable: true maxLength: 20 taxInformation: type: object required: - irsReportable properties: taxIdCertificationStatus: type: string description: The status of the Tax Id certification. nullable: true enum: - IRS has generated B notice - Entity has certified the TIN provided - TIN certificate has been sent to entity taxIdCertificationDate: type: string format: date description: | The date the Tax Id was certified. Must be a current date or past date. nullable: true bNoticesSent: type: number format: int32 default: 0 description: | The number of B Notices sent to the Entity. Valid values: 0, 1, 2 nullable: true lastBNoticeDate: type: string format: date description: | The date the last B Notice was sent to the Entity. Must be a current date or past date. nullable: true irsReportable: type: string description: Indicates how the Entity will report to the IRS. nullable: false enum: - IRS Reportable - Foreign IRS Reportable - Non-IRS Reportable foreignEntityInformation: type: object properties: citizenshipCountry: type: object properties: alpha2: description: > Must be a valid ISO 3166-1 alpha-2 country code that should be present in `CountryCode` settings. type: string minLength: 2 maxLength: 2 nullable: false reportingChapter: type: string description: The Reporting Chapter used by the Entity. nullable: true enum: - Chapter 3 - Chapter 4 chapterExemption: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false chapterStatus: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false foreignCertificationInformation: type: object properties: w8Type: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false w8CertificationDate: type: string format: date description: | The date the W8 Form was certified. Must be a current date or past date. nullable: true w8ExpirationDate: type: string format: date description: | The date the W8 Form expires. Must be a future date. nullable: true giinId: type: string description: | The GIIN Id used by the Entity. nullable: true maxLength: 19 giinProvidedDate: type: string format: date description: | The date the GIIN was provided. Must be a current date or past date. nullable: true giinCertificationDate: type: string format: date description: | The date the GIIN was certified. Must be a current date or past date. nullable: true commercial: type: object properties: sicCode: type: string format: numeric only description: >- This attribute defines the Standard Industrial Classification (SIC) code used to classify the commercial entity by industry. minLength: 4 maxLength: 4 naicsCode: type: string format: numeric only description: >- This attribute defines the North American Industry Classification System (NAICS) code used to categorize the commercial entity based on primary economic activity. minLength: 4 maxLength: 4 grossAnnualRevenue: description: > This attribute specifies the gross annual revenue of a commercial entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false financialStatementDate: type: string format: date description: > This attribute defines the commercial financial statement date. Must be a current date or past date. nullable: true createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true - type: object properties: addresses: type: array description: > An array of addresses for the entity. To create an entity, at least one address is required in the addresses list, and one of the addresses must be a mailing address. More than one Tax Address or Mailing Address is not allowed. nullable: false items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array minItems: 1 description: | The individual lines of the address. At least one line is required. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. For US addresses, it will be validated against a valid ISO 3166-2 code. For non-US addresses, it will not be validated. nullable: true maxLength: 63 postalCode: type: string description: | The postal code linked to the address. It should be an alphanumeric value. nullable: false maxLength: 11 county: type: string description: > The County for the address. Valid for US addresses only. If the state value is provided, this attribute value must be valid for the state as per the state's FIPS code. nullable: true maxLength: 255 country: type: string description: > The ISO Alpha-2 country code. Defaults to 'US' if not provided. It will be validated for existence against the `CountryCode` settings if the value is not the default "US". The value will be capitalized. nullable: true default: US maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: | The time zone in which the address is located. Alpha Only characters allowed. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 isMailing: type: boolean description: | Indicates this as a mailing address. Only one address can be set as a mailing address. nullable: true default: false isTax: type: boolean description: | Indicates this as a tax address. Only one address can be set as a tax address. nullable: true default: false seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false phoneNumbers: type: array description: An array of phone numbers for the entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: > Internal phone extension designation for a multi-line phone number. Numeric only. nullable: true maxLength: 10 countryCallingCode: type: string description: > International country code with omitted prefix. Numeric only. nullable: true label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: The Id must be a valid Phone Number Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false isPreferredContactText: type: boolean description: > Indicates the Phone Number is the preferred method for text communication to be used for the Entity. This property is only available when creating an Entity. Only one Phone Number can be preferred text. isPreferredContactVoice: type: boolean description: > Indicates the Phone Number is the preferred method for voice communication to be used for the Entity. This property is only available when creating an Entity. Only one Phone Number can be preferred voice. digitalContactPoints: type: array description: An array of digital contact points for the entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: >- The Id must be a valid Digital Contact Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false isPreferredContactEmail: type: boolean description: > Indicates the Digital Contact Point is the preferred email address to be used for the Entity. This property is only available when creating an Entity. The Digital Contact Point Type must be "Email" and only one email address can be preferred. identifications: type: array description: > An array of Identification related information used to verify an entity's identity. Duplicate values are not allowed in the list. It must not be empty when `IsIdentificationMandatory` of `EntitySettings` is true. nullable: true items: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: required: - id description: | The Id must be a valid Identification Type Id. allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true privacyOptOuts: type: array description: | An array of Privacy Opt Out options. Duplicate values are not allowed in the list. nullable: true items: type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the Opt Out Type. value: description: > If the value is null, it will be set with the default value of `PrivacyOptOutType` settings. If the value is true and `PrivacyOptOutType.NoOptOut` settings is true, it will return an error indicating the `Opt out type` cannot be opted out of. type: boolean affiliateOptOuts: type: array description: | An array of Affiliate Opt Out options. Duplicate values are not allowed in the list. nullable: true items: type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the Opt Out Type. value: description: > If the value is null, it will be set with the default value of `AffiliateOptOutType` settings. If the value is true and `AffiliateOptOutType.NoOptOut` settings is true, it will return an error indicating the `Opt out type` cannot be opted out of. type: boolean exceptionReason: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false exceptionDate: type: string format: date description: | The date when the Opt Out Exception takes effect. Date must be current date or a future date. nullable: true revokeDate: type: string format: date description: | The date when the Opt Out is to be revoked. Date must be a current date or a future date. nullable: true employments: type: array description: An array of Employments for the entity. nullable: true items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: >- This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: >- This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities-search': post: tags: - Entities description: Method to search for one or more Entity resources. operationId: searchEntity parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: offset in: query required: false description: >- When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. example: '?offset=50' schema: type: string default: '0' - schema: type: string default: '50' name: count in: query required: false description: >- The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: '?count=100' - name: includeTotals in: query description: Total related accounts returned. schema: type: boolean default: false requestBody: description: Search parameters for Entity. content: application/json: schema: type: object description: > This element is used to search for an Entity using different address components such as Name, Tax Id Number, Phone Number, Digital Contact Point and Address. Atleast one of `taxIdNumber`, `phoneNumber`, `digitalContactPoint`, `address` or `name` element must contain a value. properties: taxIdNumber: type: string description: > This element identifies the value used to search for an Entity by Tax Id Number. Matching Entities Tax Id Number Identifiers must contain value presented. It must contain only numeric characters. nullable: true minLength: 3 name: type: string description: > This element identifies the value used to search for an Entity by name. All name fields identified in `nameSearchFields` element will be searched. nullable: true minLength: 3 phoneNumber: type: string description: > This element identifies the value used to search for an Entity by Phone Number. Matching Entities Phone Numbers must contain value presented. Must be a numeric value. nullable: true minLength: 3 digitalContactPoint: type: string description: > This element identifies the value used to search for an Entity by Digital Contact Point. Matching Entities Digital Contact Point Identifiers must contain value presented. nullable: true minLength: 3 address: type: string description: > This element is used to search for an Entity using different address components. Accepts any alphanumeric value. String separators will be stripped out and not included with search terms. nullable: true minLength: 3 maxLength: 1024 responses: '200': description: Successful search. content: application/json: schema: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: listEntitySearch tags: - Entities description: >- Method to retrieve an array of Entity resources from query parameters containing Entity unique identifiers. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityIds in: query description: Identifies the Entities to list. schema: type: array items: type: string format: uuid - name: includeTotals in: query description: Total related accounts returned. schema: type: boolean default: false responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities-search-autocomplete': get: tags: - Entities description: > Method to search for entity names based on the name query parameter. Returns best-matching entity names based on full or partial text matches. At least 3 characters must be provided in the name parameter to return results. Queries with fewer than 3 characters will not return any entity names. The number of returned entity names is controlled by the count parameter: - If count is not provided, returns default 20 matching entity names. - If count is less than 5, minimum of 5 entity names will be returned. - Maximum of 100 entity names can be returned regardless of count value. operationId: searchEntitiesAutoComplete parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: name in: query description: > Partial entity name used for autocomplete search functionality. Returns matching entity names that contain or start with the provided value. At least 3 characters must be provided to return results. Queries with fewer than 3 characters will not return any entities. schema: type: string - description: > The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return 20 (default) records. If the count is less than 5, it will be set to 5. If the count is greater than 100, it will be set to 100. schema: type: integer default: 20 maximum: 100 name: count in: query required: false example: '?count=100' responses: '200': description: Successful search. content: application/json: schema: type: object properties: entities: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true name: type: string description: The name of the entity. nullable: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities-semantic-search': get: tags: - Entities description: > Method to search for entities based on the provided semantic text, which will be interpreted by AI to return entity responses. The search text may include a name, address, tax ID number, phone number, email address, or any digital contact point details. operationId: semanticSearchEntities parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: name in: query description: > Partial entity name used for autocomplete search functionality. Returns matching entity names that contain or start with the provided value. At least 3 characters must be provided to return results. Queries with fewer than 3 characters will not return any entities. schema: type: string - description: > The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return 20 (default) records. If the count is less than 5, it will be set to 5. If the count is greater than 100, it will be set to 100. schema: type: integer default: 20 maximum: 100 name: count in: query required: false example: '?count=100' requestBody: description: Search parameters for Entity. content: application/json: schema: type: object description: > Perform a Semantic Search using natural language processing to find relevant Entities. properties: semanticSearchText: type: string description: >- The text input used to perform the semantic search for entities. minLength: 3 responses: '200': description: Successful search. content: application/json: schema: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{id}': get: operationId: getEntity tags: - Entities description: Method to retrieve an Entity resource by its unique identifier. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object required: - entityType - taxIdType - entitySubtypeId - lastName - taxInformation properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityType: type: string description: | This attribute identifies the entity type. nullable: false enum: - Individual - Nonindividual entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false tinRequired: type: boolean description: Indicates if a tax id number is required. nullable: true default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: | Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 suffix: type: string description: >- This attribute defines the suffix that should follow the name of the entity. nullable: true maxLength: 31 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 foreignEntity: type: boolean description: >- This attribute designates whether the entity is a US person/Org or not. nullable: true default: false foreignTaxIdNumber: type: string description: > This attribute specifies the foreign Taxpayer Identification Number used for tax purposes in the country of residence. It will be utilized for 1042-S reporting. Must consist only of alphanumeric characters. maxLength: 25 nullable: true insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false startDate: type: string format: date description: > This attribute defines either the birth date of Individual or the start date of Nonindividual. Must be a current date or past date. nullable: true endDate: type: string format: date description: > This attribute defines either the deceased date of Individual or the end date of Nonindividual. Must be a current date or past date. nullable: true entityOfficerId: type: string format: uuid description: >- This attribute defines the primary officer Id associated to entity's account. nullable: true entityBranchAddressId: type: string format: uuid description: >- This attribute defines the branch Id associated to entity's account. nullable: true netWorth: description: > This attribute specifies the net worth currency value of the entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false gender: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false pronoun: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false race: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ethnicity: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false disability: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false incomeLevel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name - sortOrder properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false sortOrder: type: integer description: Indicates the sort order of the resource. militaryInformation: type: object description: The military information associated with this entity. properties: status: type: string description: >- This attribute indicates the military status of this entity. nullable: true enum: - Active Duty - Reserve - Inactive - Dependent activeDutyVerificationDate: type: string format: date description: This is the date active duty status was verified. nullable: true activeDutyStartDate: type: string format: date description: >- This date indicates the start date of active duty status. nullable: true activeDutySeparationDate: type: string format: date description: >- This date indicates the separation date from active duty status. nullable: true nullable: true lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true privacyOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Privacy Opt Out options. This value can only be set to true if the Institution's entity settings `AllowPrivacyOptOutAll` value is true. nullable: true default: false privacyActLastNoticeDate: type: string format: date-time description: > The timestamp of when the entity was last notified about the Privacy Act. Must be current date or a past date. nullable: true affiliateOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Affiliate Opt Out options. This value can only be set to true if the Institution's entity settings AllowAffiliateOptOutAll value is true. nullable: true default: false includeLegalEntity: type: boolean description: > This attribute represents the entity's inclusion to the FinCEN Customer Due Diligence (CDD) processes. If the value is set as false, the legal entity exclusion reason must be provided. nullable: true default: false legalEntityExclusionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false legalEntityId: type: string description: >- A unique alphanumeric identifier for legal entities participating in financial transactions. nullable: true maxLength: 20 taxInformation: type: object required: - irsReportable properties: taxIdCertificationStatus: type: string description: The status of the Tax Id certification. nullable: true enum: - IRS has generated B notice - Entity has certified the TIN provided - TIN certificate has been sent to entity taxIdCertificationDate: type: string format: date description: | The date the Tax Id was certified. Must be a current date or past date. nullable: true bNoticesSent: type: number format: int32 default: 0 description: | The number of B Notices sent to the Entity. Valid values: 0, 1, 2 nullable: true lastBNoticeDate: type: string format: date description: | The date the last B Notice was sent to the Entity. Must be a current date or past date. nullable: true irsReportable: type: string description: Indicates how the Entity will report to the IRS. nullable: false enum: - IRS Reportable - Foreign IRS Reportable - Non-IRS Reportable foreignEntityInformation: type: object properties: citizenshipCountry: type: object properties: numeric: type: string description: >- The unique ISO three numeric character code for the Country. minLength: 3 maxLength: 3 nullable: false alpha2: type: string description: >- The unique ISO two Alpha character code for the Country. minLength: 2 maxLength: 2 nullable: false alpha3: type: string description: >- The unique ISO three Alpha character code for the Country. Must contain 3 alpha characters. minLength: 3 maxLength: 3 nullable: false name: type: string description: The full name of the Country. maxLength: 255 nullable: false reportingChapter: type: string description: The Reporting Chapter used by the Entity. nullable: true enum: - Chapter 3 - Chapter 4 chapterExemption: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. chapterStatus: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. foreignCertificationInformation: type: object properties: w8Type: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 w8CertificationDate: type: string format: date description: | The date the W8 Form was certified. Must be a current date or past date. nullable: true w8ExpirationDate: type: string format: date description: | The date the W8 Form expires. Must be a future date. nullable: true giinId: type: string description: | The GIIN Id used by the Entity. nullable: true maxLength: 19 giinProvidedDate: type: string format: date description: | The date the GIIN was provided. Must be a current date or past date. nullable: true giinCertificationDate: type: string format: date description: | The date the GIIN was certified. Must be a current date or past date. nullable: true preferredContactVoiceId: type: string description: > The Id of the preferred phone number for voice calls. The value must reference an existing Phone Number for the Entity. nullable: true format: uuid preferredContactTextId: type: string description: > The Id of the preferred phone number for text messages. The value must reference an existing Phone Number for the Entity. nullable: true format: uuid preferredContactEmailId: type: string description: > The Id of the preferred contact method for emails. The value must reference an existing Digital Contact Point of Type 'Email' for the Entity. nullable: true format: uuid taxAddressId: type: string description: The Id of the tax address. nullable: true format: uuid mailingAddressId: type: string description: The Id of the mailing address. nullable: true format: uuid commercial: type: object properties: sicCode: type: string format: numeric only description: >- This attribute defines the Standard Industrial Classification (SIC) code used to classify the commercial entity by industry. minLength: 4 maxLength: 4 naicsCode: type: string format: numeric only description: >- This attribute defines the North American Industry Classification System (NAICS) code used to categorize the commercial entity based on primary economic activity. minLength: 4 maxLength: 4 grossAnnualRevenue: description: > This attribute specifies the gross annual revenue of a commercial entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false financialStatementDate: type: string format: date description: > This attribute defines the commercial financial statement date. Must be a current date or past date. nullable: true createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true addresses: type: array description: An array of addresses for the entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false phoneNumbers: type: array description: An array of phone numbers for the entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false identifications: type: array description: >- An array of Identification related information used to verify an entity's identity. nullable: true items: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: required: - id description: | The Id must be a valid Identification Type Id. allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true privacyOptOuts: type: array description: An array of Privacy Opt Out options. nullable: true items: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: >- Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false affiliateOptOuts: type: array description: An array of Affiliate Opt Out options. nullable: true items: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. exceptionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false exceptionDate: type: string format: date description: > The date when the Opt Out Exception takes effect. Date must be current date or a future date. nullable: true revokeDate: type: string format: date description: | The date when the Opt Out is to be revoked. Date must be a current date or a future date. nullable: true - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: >- Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false employments: type: array description: An array of Employments for the entity. nullable: true items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: >- This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: >- This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 ficoScore: type: string format: numeric only description: > This attribute is the FICO score of the entity. A numerical representation of the credit risk that helps FIs decide whether to approve loans or credit cards. minLength: 3 maxLength: 3 taxReturnDate: type: string format: date-time description: | This attribute defines the commercial tax return date. Must be a current date or past date. nullable: true natureOfBusiness: type: string description: > This attribute defines the nature of business for the entity. It is a free-form text field that describes the primary business activity of the entity. nullable: true maxLength: 255 '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceEntity tags: - Entities description: Method to update an Entity resource. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid - name: X-Override-Duplicate-Tax-Id-Number description: >- Indicates whether to override duplicate tax ID number check. Default is false. in: header schema: type: boolean default: false requestBody: description: Entity resource to be updated. content: application/json: schema: allOf: - type: object required: - entityType - taxIdType - entitySubtypeId - lastName - taxInformation properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityType: type: string description: | This attribute identifies the entity type. nullable: false enum: - Individual - Nonindividual entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: > If `IsEntitySubtypeMandatory` of `EntitySettings` is true, this property must have an Id value. The entity subtype must also be valid for the entity type based on `EntityTypesApplicable` settings. taxIdType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: > The tax id type must be valid for the entity type based on `EntityTypesApplicable` settings. taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: | Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 suffix: type: string description: >- This attribute defines the suffix that should follow the name of the entity. nullable: true maxLength: 31 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 foreignEntity: type: boolean description: >- This attribute designates whether the entity is a US person/Org or not. nullable: true default: false foreignTaxIdNumber: type: string description: > This attribute specifies the foreign Taxpayer Identification Number used for tax purposes in the country of residence. It will be utilized for 1042-S reporting. Must consist only of alphanumeric characters. maxLength: 25 nullable: true insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false startDate: type: string format: date description: > This attribute defines either the birth date of Individual or the start date of Nonindividual. Must be a current date or past date. nullable: true endDate: type: string format: date description: > This attribute defines either the deceased date of Individual or the end date of Nonindividual. Must be a current date or past date. nullable: true entityOfficerId: type: string format: uuid description: >- This attribute defines the primary officer Id associated to entity's account. nullable: true entityBranchAddressId: type: string format: uuid description: >- This attribute defines the branch Id associated to entity's account. nullable: true natureOfBusiness: type: string description: > This attribute defines the nature of business for the entity. It is a free-form text field that describes the primary business activity of the entity. nullable: true maxLength: 255 taxReturnDate: type: string format: date-time description: | This attribute defines the commercial tax return date. Must be a current date or past date. nullable: true ficoScore: type: string format: numeric only description: > This attribute is the FICO score of the entity. A numerical representation of the credit risk that helps FIs decide whether to approve loans or credit cards. minLength: 3 maxLength: 3 netWorth: description: > This attribute specifies the net worth currency value of the entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false gender: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. pronoun: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. race: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. ethnicity: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. disability: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. incomeLevel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. militaryInformation: allOf: - type: object description: >- The military information associated with this entity. properties: status: type: string description: >- This attribute indicates the military status of this entity. nullable: true enum: - Active Duty - Reserve - Inactive - Dependent activeDutyVerificationDate: type: string format: date description: >- This is the date active duty status was verified. nullable: true activeDutyStartDate: type: string format: date description: >- This date indicates the start date of active duty status. nullable: true activeDutySeparationDate: type: string format: date description: >- This date indicates the separation date from active duty status. nullable: true nullable: true - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true privacyOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Privacy Opt Out options. This value can only be set to true if the Institution's entity settings `AllowPrivacyOptOutAll` value is true. nullable: true default: false privacyActLastNoticeDate: type: string format: date-time description: > The timestamp of when the entity was last notified about the Privacy Act. Must be current date or a past date. nullable: true affiliateOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Affiliate Opt Out options. This value can only be set to true if the Institution's entity settings AllowAffiliateOptOutAll value is true. nullable: true default: false includeLegalEntity: type: boolean description: > This attribute represents the entity's inclusion to the FinCEN Customer Due Diligence (CDD) processes. If the value is set as false, the legal entity exclusion reason must be provided. nullable: true default: false legalEntityExclusionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- The attribute is required when `includeLegalEntity` is set to `false`. legalEntityId: type: string description: >- A unique alphanumeric identifier for legal entities participating in financial transactions. nullable: true maxLength: 20 taxInformation: type: object required: - irsReportable properties: taxIdCertificationStatus: type: string description: The status of the Tax Id certification. nullable: true enum: - IRS has generated B notice - Entity has certified the TIN provided - TIN certificate has been sent to entity taxIdCertificationDate: type: string format: date description: | The date the Tax Id was certified. Must be a current date or past date. nullable: true bNoticesSent: type: number format: int32 default: 0 description: | The number of B Notices sent to the Entity. Valid values: 0, 1, 2 nullable: true lastBNoticeDate: type: string format: date description: | The date the last B Notice was sent to the Entity. Must be a current date or past date. nullable: true irsReportable: type: string description: Indicates how the Entity will report to the IRS. nullable: false enum: - IRS Reportable - Foreign IRS Reportable - Non-IRS Reportable foreignEntityInformation: type: object properties: citizenshipCountry: type: object properties: alpha2: description: > Must be a valid ISO 3166-1 alpha-2 country code that should be present in `CountryCode` settings. type: string minLength: 2 maxLength: 2 nullable: false reportingChapter: type: string description: The Reporting Chapter used by the Entity. nullable: true enum: - Chapter 3 - Chapter 4 chapterExemption: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false chapterStatus: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false foreignCertificationInformation: type: object properties: w8Type: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false w8CertificationDate: type: string format: date description: | The date the W8 Form was certified. Must be a current date or past date. nullable: true w8ExpirationDate: type: string format: date description: | The date the W8 Form expires. Must be a future date. nullable: true giinId: type: string description: | The GIIN Id used by the Entity. nullable: true maxLength: 19 giinProvidedDate: type: string format: date description: | The date the GIIN was provided. Must be a current date or past date. nullable: true giinCertificationDate: type: string format: date description: | The date the GIIN was certified. Must be a current date or past date. nullable: true commercial: type: object properties: sicCode: type: string format: numeric only description: >- This attribute defines the Standard Industrial Classification (SIC) code used to classify the commercial entity by industry. minLength: 4 maxLength: 4 naicsCode: type: string format: numeric only description: >- This attribute defines the North American Industry Classification System (NAICS) code used to categorize the commercial entity based on primary economic activity. minLength: 4 maxLength: 4 grossAnnualRevenue: description: > This attribute specifies the gross annual revenue of a commercial entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false financialStatementDate: type: string format: date description: > This attribute defines the commercial financial statement date. Must be a current date or past date. nullable: true createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true - type: object properties: preferredContactVoiceId: type: string description: > The Id of the preferred phone number for voice calls. The value must reference an existing Phone Number for the Entity. nullable: true format: uuid preferredContactTextId: type: string description: > The Id of the preferred phone number for text messages. The value must reference an existing Phone Number for the Entity. nullable: true format: uuid preferredContactEmailId: type: string description: > The Id of the preferred contact method for emails. The value must reference an existing Digital Contact Point of Type 'Email' for the Entity. nullable: true format: uuid taxAddressId: type: string description: The Id of the tax address. nullable: true format: uuid mailingAddressId: type: string description: The Id of the mailing address. nullable: true format: uuid responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteEntity tags: - Entities description: > Method to delete an Entity resource. The deletion will only proceed if all associated relationships have been deleted beforehand. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{id}/notices/mailing-address-change-email-notice': post: operationId: addressChangeNewWrittenNotice tags: - Notices description: > Generates email notices for address changes within the given date range to be sent to the entity's preferred email address. An error will be returned if the entity does not have a preferred email address. The response will include a list of notification ids which can be used to monitor the status of the ENS notification. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid - name: minimumDate in: query description: > The minimum date to be returned in the query results. If `minimumDate` is not provided but `maximumDate` is provided, `minimumDate` will be set to the value of `maximumDate`. If both `minimumDate` and `maximumDate` are provided, `minimumDate` must be less than or equal to `maximumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults the `minimumDate` to the current date. The format for `minimumDate` is `MM/DD/YYYY`. The method will throw an error response if `minimumDate` is not in the expected format. schema: type: string format: date - name: maximumDate in: query description: > The maximum date to be returned in the query results. If `maximumDate` is not provided but `minimumDate` is provided, `maximumDate` will default to the system's maximum allowable date. If both `minimumDate` and `maximumDate` are provided, `maximumDate` must be greater than the `minimumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults this value to the current date. The format for `maximumDate` is `MM/DD/YYYY`. The method will throw an error response if `maximumDate` is not in the expected format. schema: type: string format: date - name: timezoneOffset in: query description: > Hour and minute offset to be used for any data fetch. If `timezoneOffset` is not provided, the system defaults it to `0`. The format for `timezoneOffset` is in `HH:MM` format. The method will return an error response if `timezoneOffset` is not in the expected format. schema: type: string format: '±hh:mm' responses: '201': description: Successful create. content: application/json: schema: type: object properties: ids: type: array items: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{id}/notices/mailing-address-change-new-written-notice': post: operationId: mailingAddressChangeNewWrittenNotice tags: - Notices description: > Generates written notices for address changes within the given date range to be sent to the entity's new address. The response will include a list of report ids which can be used to download the generated reports from the GET `/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/reports/{id}` endpoint. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid - name: minimumDate in: query description: > The minimum date to be returned in the query results. If `minimumDate` is not provided but `maximumDate` is provided, `minimumDate` will be set to the value of `maximumDate`. If both `minimumDate` and `maximumDate` are provided, `minimumDate` must be less than or equal to `maximumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults the `minimumDate` to the current date. The format for `minimumDate` is `MM/DD/YYYY`. The method will throw an error response if `minimumDate` is not in the expected format. schema: type: string format: date - name: maximumDate in: query description: > The maximum date to be returned in the query results. If `maximumDate` is not provided but `minimumDate` is provided, `maximumDate` will default to the system's maximum allowable date. If both `minimumDate` and `maximumDate` are provided, `maximumDate` must be greater than the `minimumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults this value to the current date. The format for `maximumDate` is `MM/DD/YYYY`. The method will throw an error response if `maximumDate` is not in the expected format. schema: type: string format: date responses: '201': description: Successful create. content: application/json: schema: type: object properties: ids: type: array items: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{id}/notices/mailing-address-change-old-written-notice': post: operationId: addressChangeOldWrittenNotice tags: - Notices description: > Generates written notices for address changes within the given date range to be sent to the entity's old address. The response will include a list of report ids which can be used to download the generated reports from the GET `/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/reports/{id}` endpoint. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid - name: minimumDate in: query description: > The minimum date to be returned in the query results. If `minimumDate` is not provided but `maximumDate` is provided, `minimumDate` will be set to the value of `maximumDate`. If both `minimumDate` and `maximumDate` are provided, `minimumDate` must be less than or equal to `maximumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults the `minimumDate` to the current date. The format for `minimumDate` is `MM/DD/YYYY`. The method will throw an error response if `minimumDate` is not in the expected format. schema: type: string format: date - name: maximumDate in: query description: > The maximum date to be returned in the query results. If `maximumDate` is not provided but `minimumDate` is provided, `maximumDate` will default to the system's maximum allowable date. If both `minimumDate` and `maximumDate` are provided, `maximumDate` must be greater than the `minimumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults this value to the current date. The format for `maximumDate` is `MM/DD/YYYY`. The method will throw an error response if `maximumDate` is not in the expected format. schema: type: string format: date - name: timezoneOffset in: query description: > Hour and minute offset to be used for any data fetch. If `timezoneOffset` is not provided, the system defaults it to `0`. The format for `timezoneOffset` is in `HH:MM` format. The method will return an error response if `timezoneOffset` is not in the expected format. schema: type: string format: '±hh:mm' responses: '201': description: Successful create. content: application/json: schema: type: object properties: ids: type: array items: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{id}/notices/mailing-address-change-text-notice': post: operationId: mailingAddressChangeTextNotice tags: - Notices description: > Generates text message notices for address changes within the given date range to be sent to the entity's preferred text phone number address. An error will be returned if the entity does not have a preferred email address. The response will include a list of notification ids which can be used to monitor the status of the ENS notification. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid - name: minimumDate in: query description: > The minimum date to be returned in the query results. If `minimumDate` is not provided but `maximumDate` is provided, `minimumDate` will be set to the value of `maximumDate`. If both `minimumDate` and `maximumDate` are provided, `minimumDate` must be less than or equal to `maximumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults the `minimumDate` to the current date. The format for `minimumDate` is `MM/DD/YYYY`. The method will throw an error response if `minimumDate` is not in the expected format. schema: type: string format: date - name: maximumDate in: query description: > The maximum date to be returned in the query results. If `maximumDate` is not provided but `minimumDate` is provided, `maximumDate` will default to the system's maximum allowable date. If both `minimumDate` and `maximumDate` are provided, `maximumDate` must be greater than the `minimumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults this value to the current date. The format for `maximumDate` is `MM/DD/YYYY`. The method will throw an error response if `maximumDate` is not in the expected format. schema: type: string format: date - name: timezoneOffset in: query description: > Hour and minute offset to be used for any data fetch. If `timezoneOffset` is not provided, the system defaults it to `0`. The format for `timezoneOffset` is in `HH:MM` format. The method will return an error response if `timezoneOffset` is not in the expected format. schema: type: string format: '±hh:mm' responses: '201': description: Successful create. content: application/json: schema: type: object properties: ids: type: array items: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{id}/notices/email-change-email-notice': post: operationId: emailChangeEmailNotice tags: - Notices description: > Generates email notices for email changes within the given date range to be sent to the entity's preferred email address. An error will be returned if the entity does not have a preferred email address. The response will include a list of notification ids which can be used to monitor the status of the ENS notification. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid - name: minimumDate in: query description: > The minimum date to be returned in the query results. If `minimumDate` is not provided but `maximumDate` is provided, `minimumDate` will be set to the value of `maximumDate`. If both `minimumDate` and `maximumDate` are provided, `minimumDate` must be less than or equal to `maximumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults the `minimumDate` to the current date. The format for `minimumDate` is `MM/DD/YYYY`. The method will throw an error response if `minimumDate` is not in the expected format. schema: type: string format: date - name: maximumDate in: query description: > The maximum date to be returned in the query results. If `maximumDate` is not provided but `minimumDate` is provided, `maximumDate` will default to the system's maximum allowable date. If both `minimumDate` and `maximumDate` are provided, `maximumDate` must be greater than the `minimumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults this value to the current date. The format for `maximumDate` is `MM/DD/YYYY`. The method will throw an error response if `maximumDate` is not in the expected format. schema: type: string format: date responses: '201': description: Successful create. content: application/json: schema: type: object properties: ids: type: array items: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{id}/notices/email-change-text-notice': post: operationId: emailChangeTextNotice tags: - Notices description: > Generates a text message notices for email changes within the given date range to be sent to the entity's preferred text number. An error will be returned if the entity does not have a preferred text number. The response will include a list of notification ids which can be used to monitor the status of the ENS notification. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid - name: minimumDate in: query description: > The minimum date to be returned in the query results. If `minimumDate` is not provided but `maximumDate` is provided, `minimumDate` will be set to the value of `maximumDate`. If both `minimumDate` and `maximumDate` are provided, `minimumDate` must be less than or equal to `maximumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults the `minimumDate` to the current date. The format for `minimumDate` is `MM/DD/YYYY`. The method will throw an error response if `minimumDate` is not in the expected format. schema: type: string format: date - name: maximumDate in: query description: > The maximum date to be returned in the query results. If `maximumDate` is not provided but `minimumDate` is provided, `maximumDate` will default to the system's maximum allowable date. If both `minimumDate` and `maximumDate` are provided, `maximumDate` must be greater than the `minimumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults this value to the current date. The format for `maximumDate` is `MM/DD/YYYY`. The method will throw an error response if `maximumDate` is not in the expected format. schema: type: string format: date responses: '201': description: Successful create. content: application/json: schema: type: object properties: ids: type: array items: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{id}/notices/email-change-written-notice': post: operationId: emailChangeWrittenNotice tags: - Notices description: > Generates written notices for email changes within the given date range to be sent to the current mailing address. The response will include a list of report ids which can be used to download the generated reports from the GET `/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/reports/{id}` endpoint. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid - name: minimumDate in: query description: > The minimum date to be returned in the query results. If `minimumDate` is not provided but `maximumDate` is provided, `minimumDate` will be set to the value of `maximumDate`. If both `minimumDate` and `maximumDate` are provided, `minimumDate` must be less than or equal to `maximumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults the `minimumDate` to the current date. The format for `minimumDate` is `MM/DD/YYYY`. The method will throw an error response if `minimumDate` is not in the expected format. schema: type: string format: date - name: maximumDate in: query description: > The maximum date to be returned in the query results. If `maximumDate` is not provided but `minimumDate` is provided, `maximumDate` will default to the system's maximum allowable date. If both `minimumDate` and `maximumDate` are provided, `maximumDate` must be greater than the `minimumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults this value to the current date. The format for `maximumDate` is `MM/DD/YYYY`. The method will throw an error response if `maximumDate` is not in the expected format. schema: type: string format: date - name: timezoneOffset in: query description: > Hour and minute offset to be used for any data fetch. If `timezoneOffset` is not provided, the system defaults it to `0`. The format for `timezoneOffset` is in `HH:MM` format. The method will return an error response if `timezoneOffset` is not in the expected format. schema: type: string format: '±hh:mm' responses: '201': description: Successful create. content: application/json: schema: type: object properties: ids: type: array items: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{id}/notices/w8-expiration-written-notice': post: operationId: w8ExpirationWrittenNotice tags: - Notices description: > Generates written notices for W8 expirations for an Entity to be sent to the entity's current mailing address. The response will include a list of report ids which can be used to download the generated reports from the GET `/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/reports/{id}` endpoint. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/addresses': post: operationId: createAddress tags: - Addresses description: Method to add an Address to an Entity. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid requestBody: description: The Address to be created. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array minItems: 1 description: | The individual lines of the address. At least one line is required. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. For US addresses, it will be validated against a valid ISO 3166-2 code. For non-US addresses, it will not be validated. nullable: true maxLength: 63 postalCode: type: string description: | The postal code linked to the address. It should be an alphanumeric value. nullable: false maxLength: 11 county: type: string description: > The County for the address. Valid for US addresses only. If the state value is provided, this attribute value must be valid for the state as per the state's FIPS code. nullable: true maxLength: 255 country: type: string description: > The ISO Alpha-2 country code. Defaults to 'US' if not provided. It will be validated for existence against the `CountryCode` settings if the value is not the default "US". The value will be capitalized. nullable: true default: US maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: | The time zone in which the address is located. Alpha Only characters allowed. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 isMailing: type: boolean description: | Indicates this as a mailing address. Only one address can be set as a mailing address. nullable: true default: false isTax: type: boolean description: | Indicates this as a tax address. Only one address can be set as a tax address. nullable: true default: false seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: This attribute defines the end date for Seasonal Addresses. addressLabel: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: listAddress tags: - Addresses description: >- Method to retrieve an array of Address resources by the Entity's unique identifier. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: addresses: type: array items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/addresses/{id}': put: operationId: replaceAddress tags: - Addresses description: Method to update an Address resource. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: Address resource to be updated. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array minItems: 1 description: | The individual lines of the address. At least one line is required. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. For US addresses, it will be validated against a valid ISO 3166-2 code. For non-US addresses, it will not be validated. nullable: true maxLength: 63 postalCode: type: string description: | The postal code linked to the address. It should be an alphanumeric value. nullable: false maxLength: 11 county: type: string description: > The County for the address. Valid for US addresses only. If the state value is provided, this attribute value must be valid for the state as per the state's FIPS code. nullable: true maxLength: 255 country: type: string description: > The ISO Alpha-2 country code. Defaults to 'US' if not provided. It will be validated for existence against the `CountryCode` settings if the value is not the default "US". The value will be capitalized. nullable: true default: US maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: | The time zone in which the address is located. Alpha Only characters allowed. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 isMailing: type: boolean description: | Indicates this as a mailing address. Only one address can be set as a mailing address. nullable: true default: false isTax: type: boolean description: | Indicates this as a tax address. Only one address can be set as a tax address. nullable: true default: false seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: This attribute defines the end date for Seasonal Addresses. addressLabel: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: getAddress tags: - Addresses description: Method to retrieve an Address resource by its unique identifier. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteAddress tags: - Addresses description: > Method to delete an Address resource. Deletion is only allowed if the address is not a tax or mailing address. If the address is a tax or mailing address, it must first be replaced with a new address before deletion. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/addresses/{id}/structured-address': get: operationId: getStructuredAddress tags: - Addresses description: >- Method to retrieve a Structured Address version of an Address, json or xml parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid - name: accept description: >- Indicates whether to return a json or xml response. Default response type is json. in: header schema: type: string default: application/json responses: '200': description: Successful retrieve. content: application/json: schema: type: object required: - details properties: adrTp: type: string description: The type of address (structured or hybrid) nullable: true bldgNm: type: string description: The name of the building nullable: true bldgNb: type: string description: The number of the building nullable: true ctrySubDvsn: type: string description: The country subdivision nullable: true ctry: type: string description: The country nullable: true dept: type: string description: The department nullable: true dstrctNm: type: string description: The district name nullable: true flr: type: string description: The floor nullable: true pstBx: type: string description: The postbox nullable: true pstCd: type: string description: The postcode nullable: true room: type: string description: The room nullable: true strtNm: type: string description: The street name nullable: true subDept: type: string description: The sub department nullable: true twnLctnNm: type: string description: The town location name nullable: true twnNm: type: string description: The town name nullable: true application/xml: schema: type: object required: - details properties: adrTp: type: string description: The type of address (structured or hybrid) nullable: true bldgNm: type: string description: The name of the building nullable: true bldgNb: type: string description: The number of the building nullable: true ctrySubDvsn: type: string description: The country subdivision nullable: true ctry: type: string description: The country nullable: true dept: type: string description: The department nullable: true dstrctNm: type: string description: The district name nullable: true flr: type: string description: The floor nullable: true pstBx: type: string description: The postbox nullable: true pstCd: type: string description: The postcode nullable: true room: type: string description: The room nullable: true strtNm: type: string description: The street name nullable: true subDept: type: string description: The sub department nullable: true twnLctnNm: type: string description: The town location name nullable: true twnNm: type: string description: The town name nullable: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/digital-contact-points': post: operationId: createDigitalContactPoint tags: - Digital Contact Points description: Method to add a digital contact point to an Entity. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid requestBody: description: The digital contact point to be created. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: The Id must be a valid Digital Contact Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: listDigitalContactPoint tags: - Digital Contact Points description: >- Method to retrieve an array of Phone Number resources by the Entity's unique identifier. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: digitalContactPoints: type: array items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/digital-contact-points/{id}': put: operationId: replaceDigitalContactPoint tags: - Digital Contact Points description: Method to update a Phone Number resource. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: Phone Number resource to be updated. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: The Id must be a valid Digital Contact Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: getDigitalContactPoint tags: - Digital Contact Points description: Method to retrieve a Phone Number resource by its unique identifier. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteDigitalContactPoint tags: - Digital Contact Points description: > Method to delete a digital contact point resource. If the digital contact point to be deleted is a preferred contact email, it cannot be deleted. A new preferred contact email must be selected before proceeding with the deletion. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/phone-numbers': post: operationId: createPhoneNumber tags: - Phone Numbers description: Method to add a Phone Number to an Entity. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid requestBody: description: The Phone Number to be created. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: > Internal phone extension designation for a multi-line phone number. Numeric only. nullable: true maxLength: 10 countryCallingCode: type: string description: | International country code with omitted prefix. Numeric only. nullable: true label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: The Id must be a valid Phone Number Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: listPhoneNumber tags: - Phone Numbers description: >- Method to retrieve an array of Phone Number resources by the Entity's unique identifier. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: phoneNumbers: type: array items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/phone-numbers/{id}': put: operationId: replacePhoneNumber tags: - Phone Numbers description: Method to update a Phone Number resource. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: Phone Number resource to be updated. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: > Internal phone extension designation for a multi-line phone number. Numeric only. nullable: true maxLength: 10 countryCallingCode: type: string description: | International country code with omitted prefix. Numeric only. nullable: true label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: The Id must be a valid Phone Number Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: getPhoneNumber tags: - Phone Numbers description: Method to retrieve a Phone Number resource by its unique identifier. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deletePhoneNumber tags: - Phone Numbers description: > Method to delete a Phone Number resource. If the phone number to be deleted is a preferred contact voice id or text id, it cannot be deleted. A new preferred contact voice id or text id must be selected before proceeding with the deletion. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/identifications': post: operationId: createIdentification tags: - Identifications description: Method to add an Identification to an Entity. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid requestBody: description: The Identification to be created. content: application/json: schema: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: | The Id must be a valid Identification Type Id. idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: listIdentification tags: - Identifications description: >- Method to retrieve an array of Identification resources by the Entity's unique identifier. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: identifications: type: array items: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: required: - id description: | The Id must be a valid Identification Type Id. allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/identifications/{id}': put: operationId: replaceIdentification tags: - Identifications description: Method to update an Identification resource. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: Identification resource to be updated. content: application/json: schema: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: | The Id must be a valid Identification Type Id. idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: getIdentification tags: - Identifications description: Method to retrieve an Identification resource by its unique identifier. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: required: - id description: | The Id must be a valid Identification Type Id. allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteIdentification tags: - Identifications description: > Method to delete an Identification resource. If the `IsIdentificationMandatory` is set to true in settings, then the last entry of Identification cannot be deleted. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/privacy-opt-outs': get: operationId: listPrivacyOptOut tags: - Privacy Opt Outs description: >- Method to retrieve an array of Privacy Opt Out resources by the Entity's unique identifier. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: PrivacyOptOuts: type: array items: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: >- Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/privacy-opt-outs/{id}': put: operationId: replacePrivacyOptOut tags: - Privacy Opt Outs description: Method to update a Privacy Opt Out resource. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: Privacy Opt Out resource to be updated. content: application/json: schema: type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: getPrivacyOptOut tags: - Privacy Opt Outs description: Method to retrieve a Privacy Opt Out resource by its unique identifier. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/affiliate-opt-outs': get: operationId: listAffiliateOptOuts tags: - Affiliate Opt Outs description: >- Method to retrieve an array of Affiliate Opt Out resources by the Entity's unique identifier. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: AffiliateOptOuts: type: array items: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. exceptionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false exceptionDate: type: string format: date description: > The date when the Opt Out Exception takes effect. Date must be current date or a future date. nullable: true revokeDate: type: string format: date description: | The date when the Opt Out is to be revoked. Date must be a current date or a future date. nullable: true - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: >- Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/affiliate-opt-outs/{id}': put: operationId: replaceAffiliateOptOut tags: - Affiliate Opt Outs description: Method to update an Affiliate Opt Out resource. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: Affiliate Opt Out resource to be updated. content: application/json: schema: type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. exceptionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false exceptionDate: type: string format: date description: | The date when the Opt Out Exception takes effect. Date must be current date or a future date. nullable: true revokeDate: type: string format: date description: | The date when the Opt Out is to be revoked. Date must be a current date or a future date. nullable: true responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: getAffiliateOptOut tags: - Affiliate Opt Outs description: >- Method to retrieve an Affiliate Opt Out resource by its unique identifier. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. exceptionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false exceptionDate: type: string format: date description: | The date when the Opt Out Exception takes effect. Date must be current date or a future date. nullable: true revokeDate: type: string format: date description: | The date when the Opt Out is to be revoked. Date must be a current date or a future date. nullable: true - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/employments': post: operationId: createEmployment tags: - Employments description: Method to add an Employment to an Entity. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid requestBody: description: The Employment to be created. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: >- This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: >- This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: listEmployments tags: - Employments description: >- Method to retrieve an array of Employment resources by the Entity's unique identifier. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: employments: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: >- This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: >- This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/employments/{id}': put: operationId: replaceEmployment tags: - Employments description: Method to update an Employment resource. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: Employment resource to be updated. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: >- This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: >- This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: getEmployment tags: - Employments description: Method to retrieve an Employment resource by its unique identifier. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: >- This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: >- This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteEmployment tags: - Employments description: Method to delete an Employment resource. parameters: - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/reports/{id}': get: operationId: getReport tags: - Reports description: > Downloads the document for the given report id generated by one of the report creation endpoints. A 202 response indicates the report has not completed the generation process but will be available soon. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful download. content: application/pdf: schema: type: string format: binary description: The content of the downloaded file. readOnly: true '202': description: Report is being generated. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/reports/certified-foreign-entities': post: operationId: createCertifiedForeignEntitiesReport tags: - Reports description: | Generates a Certified Foreign Entity Report. The time zone offset is used to specify the time zone for the report. The offset format should be in the form of +/-HH:MM. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: timezoneOffset in: query description: > Hour and minute offset to be used for any data fetch. If `timezoneOffset` is not provided, the system defaults it to `0`. The format for `timezoneOffset` is in `HH:MM` format. The method will return an error response if `timezoneOffset` is not in the expected format. schema: type: string format: '±hh:mm' responses: '202': description: Accepted. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/reports/expired-foreign-entities': post: operationId: createExpiredForeignEntitiesReport tags: - Reports description: | Method to generate an Expired Foreign Entity Report. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: minimumDate in: query description: > The minimum date to be returned in the query results. If `minimumDate` is not provided but `maximumDate` is provided, `minimumDate` will be set to the value of `maximumDate`. If both `minimumDate` and `maximumDate` are provided, `minimumDate` must be less than or equal to `maximumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults the `minimumDate` to the current date. The format for `minimumDate` is `MM/DD/YYYY`. The method will throw an error response if `minimumDate` is not in the expected format. schema: type: string format: date - name: maximumDate in: query description: > The maximum date to be returned in the query results. If `maximumDate` is not provided but `minimumDate` is provided, `maximumDate` will default to the system's maximum allowable date. If both `minimumDate` and `maximumDate` are provided, `maximumDate` must be greater than the `minimumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults this value to the current date. The format for `maximumDate` is `MM/DD/YYYY`. The method will throw an error response if `maximumDate` is not in the expected format. schema: type: string format: date - name: timezoneOffset in: query description: > Hour and minute offset to be used for any data fetch. If `timezoneOffset` is not provided, the system defaults it to `0`. The format for `timezoneOffset` is in `HH:MM` format. The method will return an error response if `timezoneOffset` is not in the expected format. schema: type: string format: '±hh:mm' responses: '202': description: Accepted. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/reports/activity-logs': post: operationId: createActivityLoggingReport tags: - Reports description: | Method to generate an Activity Log Report. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: minimumDate in: query description: > The minimum date to be returned in the query results. If `minimumDate` is not provided but `maximumDate` is provided, `minimumDate` will be set to the value of `maximumDate`. If both `minimumDate` and `maximumDate` are provided, `minimumDate` must be less than or equal to `maximumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults the `minimumDate` to the current date. The format for `minimumDate` is `MM/DD/YYYY`. The method will throw an error response if `minimumDate` is not in the expected format. schema: type: string format: date - name: maximumDate in: query description: > The maximum date to be returned in the query results. If `maximumDate` is not provided but `minimumDate` is provided, `maximumDate` will default to the system's maximum allowable date. If both `minimumDate` and `maximumDate` are provided, `maximumDate` must be greater than the `minimumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults this value to the current date. The format for `maximumDate` is `MM/DD/YYYY`. The method will throw an error response if `maximumDate` is not in the expected format. schema: type: string format: date - name: timezoneOffset in: query description: > Hour and minute offset to be used for any data fetch. If `timezoneOffset` is not provided, the system defaults it to `0`. The format for `timezoneOffset` is in `HH:MM` format. The method will return an error response if `timezoneOffset` is not in the expected format. schema: type: string format: '±hh:mm' responses: '202': description: Accepted. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/reports/addresses-changes': post: operationId: AddressChanges tags: - Reports description: | Method to generate an Address Change Report. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: minimumDate in: query description: > The minimum date to be returned in the query results. If `minimumDate` is not provided but `maximumDate` is provided, `minimumDate` will be set to the value of `maximumDate`. If both `minimumDate` and `maximumDate` are provided, `minimumDate` must be less than or equal to `maximumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults the `minimumDate` to the current date. The format for `minimumDate` is `MM/DD/YYYY`. The method will throw an error response if `minimumDate` is not in the expected format. schema: type: string format: date - name: maximumDate in: query description: > The maximum date to be returned in the query results. If `maximumDate` is not provided but `minimumDate` is provided, `maximumDate` will default to the system's maximum allowable date. If both `minimumDate` and `maximumDate` are provided, `maximumDate` must be greater than the `minimumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults this value to the current date. The format for `maximumDate` is `MM/DD/YYYY`. The method will throw an error response if `maximumDate` is not in the expected format. schema: type: string format: date - name: timezoneOffset in: query description: > Hour and minute offset to be used for any data fetch. If `timezoneOffset` is not provided, the system defaults it to `0`. The format for `timezoneOffset` is in `HH:MM` format. The method will return an error response if `timezoneOffset` is not in the expected format. schema: type: string format: '±hh:mm' responses: '202': description: Accepted. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/reports/email-changes': post: operationId: createEmailChangeReport tags: - Reports description: | Method to generate an Email Change Report. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: minimumDate in: query description: > The minimum date to be returned in the query results. If `minimumDate` is not provided but `maximumDate` is provided, `minimumDate` will be set to the value of `maximumDate`. If both `minimumDate` and `maximumDate` are provided, `minimumDate` must be less than or equal to `maximumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults the `minimumDate` to the current date. The format for `minimumDate` is `MM/DD/YYYY`. The method will throw an error response if `minimumDate` is not in the expected format. schema: type: string format: date - name: maximumDate in: query description: > The maximum date to be returned in the query results. If `maximumDate` is not provided but `minimumDate` is provided, `maximumDate` will default to the system's maximum allowable date. If both `minimumDate` and `maximumDate` are provided, `maximumDate` must be greater than the `minimumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults this value to the current date. The format for `maximumDate` is `MM/DD/YYYY`. The method will throw an error response if `maximumDate` is not in the expected format. schema: type: string format: date - name: timezoneOffset in: query description: > Hour and minute offset to be used for any data fetch. If `timezoneOffset` is not provided, the system defaults it to `0`. The format for `timezoneOffset` is in `HH:MM` format. The method will return an error response if `timezoneOffset` is not in the expected format. schema: type: string format: '±hh:mm' responses: '202': description: Accepted. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/reports/audit-logs': post: operationId: createAuditLoggingReport tags: - Reports description: | Method to generate an Audit Log Report for Entities. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: minimumDate in: query description: > The minimum date to be returned in the query results. If `minimumDate` is not provided but `maximumDate` is provided, `minimumDate` will be set to the value of `maximumDate`. If both `minimumDate` and `maximumDate` are provided, `minimumDate` must be less than or equal to `maximumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults the `minimumDate` to the current date. The format for `minimumDate` is `MM/DD/YYYY`. The method will throw an error response if `minimumDate` is not in the expected format. schema: type: string format: date - name: maximumDate in: query description: > The maximum date to be returned in the query results. If `maximumDate` is not provided but `minimumDate` is provided, `maximumDate` will default to the system's maximum allowable date. If both `minimumDate` and `maximumDate` are provided, `maximumDate` must be greater than the `minimumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults this value to the current date. The format for `maximumDate` is `MM/DD/YYYY`. The method will throw an error response if `maximumDate` is not in the expected format. schema: type: string format: date - name: entityId in: query description: Entity Id passed in as query parameter. schema: type: string format: uuid - name: timezoneOffset in: query description: > Hour and minute offset to be used for any data fetch. If `timezoneOffset` is not provided, the system defaults it to `0`. The format for `timezoneOffset` is in `HH:MM` format. The method will return an error response if `timezoneOffset` is not in the expected format. schema: type: string format: '±hh:mm' responses: '202': description: Accepted. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/reports/expired-identifications': post: operationId: createExpiredIdentificationReport tags: - Reports description: | Method to generate expired identification report for Entities. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: minimumDate in: query description: > The minimum date to be returned in the query results. If `minimumDate` is not provided but `maximumDate` is provided, `minimumDate` will be set to the value of `maximumDate`. If both `minimumDate` and `maximumDate` are provided, `minimumDate` must be less than or equal to `maximumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults the `minimumDate` to the current date. The format for `minimumDate` is `MM/DD/YYYY`. The method will throw an error response if `minimumDate` is not in the expected format. schema: type: string format: date - name: maximumDate in: query description: > The maximum date to be returned in the query results. If `maximumDate` is not provided but `minimumDate` is provided, `maximumDate` will default to the system's maximum allowable date. If both `minimumDate` and `maximumDate` are provided, `maximumDate` must be greater than the `minimumDate`. If both `minimumDate` and `maximumDate` are not provided, the system defaults this value to the current date. The format for `maximumDate` is `MM/DD/YYYY`. The method will throw an error response if `maximumDate` is not in the expected format. schema: type: string format: date - name: timezoneOffset in: query description: > Hour and minute offset to be used for any data fetch. If `timezoneOffset` is not provided, the system defaults it to `0`. The format for `timezoneOffset` is in `HH:MM` format. The method will return an error response if `timezoneOffset` is not in the expected format. schema: type: string format: '±hh:mm' responses: '202': description: Accepted. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/abilities': get: operationId: ListAbilities tags: - Abilities description: Retrieves the abilities for a given user. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. responses: '200': description: A list of abilities content: application/json: schema: type: object required: - addEntities - addEntityRelationships - addEntitySettings - addProfileImages - deleteEntities - deleteEntityRelationships - deleteEntitySettings - deleteProfileImages - editEntities - editEntitlements - editEntityRelationships - editEntitySettings - editProfileImages - editTaxIDNumbers - searchEntities - searchEntityRelationships - viewEntities - viewEntitlements - viewEntityRelationships - viewEntityReports - viewEntitySettings - viewProfileImages - viewTaxIDNumbers properties: addEntities: type: boolean nullable: false default: false addEntityRelationships: type: boolean nullable: false default: false addEntitySettings: type: boolean nullable: false default: false addProfileImages: type: boolean nullable: false default: false deleteEntities: type: boolean nullable: false default: false deleteEntityRelationships: type: boolean nullable: false default: false deleteEntitySettings: type: boolean nullable: false default: false deleteProfileImages: type: boolean nullable: false default: false editEntities: type: boolean nullable: false default: false editEntitlements: type: boolean nullable: false default: false editEntityRelationships: type: boolean nullable: false default: false editEntitySettings: type: boolean nullable: false default: false editProfileImages: type: boolean nullable: false default: false editTaxIDNumbers: type: boolean nullable: false default: false searchEntities: type: boolean nullable: false default: false searchEntityRelationships: type: boolean nullable: false default: false viewEntities: type: boolean nullable: false default: false viewEntitlements: type: boolean nullable: false default: false viewEntityRelationships: type: boolean nullable: false default: false viewEntityReports: type: boolean nullable: false default: false viewEntitySettings: type: boolean nullable: false default: false viewProfileImages: type: boolean nullable: false default: false viewTaxIDNumbers: type: boolean nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/tax-id-number': get: operationId: getTaxIdNumber tags: - Tax Id Number description: Method to retrieve the tax id number for an entity. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: formatTaxIdNumber in: query description: > When set to true, it formats the Tax ID Number according to standard conventions (e.g., adding dashes). For Individual Tax ID Number the format will be XXX-XX-XXXX. For Employer Identification Number the format will be XX-XXXXXXX. By default, this property is false, and the Tax ID Number response is an unformatted string. schema: type: boolean default: false responses: '200': description: Successful retrieve. content: application/json: schema: type: object required: - id - taxIdNumber properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceTaxIdNumber tags: - Tax Id Number description: Method to update the tax id number for an entity. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: X-Override-Duplicate-Tax-Id-Number description: >- Indicates whether to override duplicate tax ID number check. Default is false. in: header schema: type: boolean default: false requestBody: description: Tax Id Number to update the entity with. content: application/json: schema: type: object required: - taxIdNumber properties: taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/tax-id-number-exists': post: operationId: taxIdNumberExists tags: - Tax Id Number description: Method to find out if a Tax Id Number already Exists. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. requestBody: description: Tax Id Number to find out if it exists or not. content: application/json: schema: type: object required: - taxIdNumber properties: taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true responses: '200': description: Tax Id Exists. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/foreign-tax-id-number': get: operationId: getForeignTaxIdNumber tags: - Foreign Tax Id Number description: Method to retrieve the foreign tax id number for an entity. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object required: - id - taxIdNumber properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true taxIdNumber: type: string description: > This attribute specifies the foreign Taxpayer Identification Number used for tax purposes in the country of residence. It will be utilized for 1042-S reporting. Must consist only of alphanumeric characters. maxLength: 25 nullable: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceForeignTaxIdNumber tags: - Foreign Tax Id Number description: Method to update the foreign tax id number for an entity. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid requestBody: description: Foreign Tax Id Number to update the entity with. content: application/json: schema: type: object required: - taxIdNumber properties: taxIdNumber: type: string description: > This attribute specifies the foreign Taxpayer Identification Number used for tax purposes in the country of residence. It will be utilized for 1042-S reporting. Must consist only of alphanumeric characters. maxLength: 25 nullable: true responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entitlements/{EnterpriseUserId}': get: operationId: getEntitlement tags: - Entitlements description: Method to retrieve entitlements for a user. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: viewVip: type: boolean nullable: false default: false editVip: type: boolean nullable: false default: false viewInsiderRoles: type: array items: type: string format: uuid default: [] editInsiderRoles: type: array items: type: string format: uuid default: [] viewEntitiesAllowed: type: array items: type: string format: uuid default: [] editEntitiesAllowed: type: array items: type: string format: uuid default: [] viewEntitiesDenied: type: array items: type: string format: uuid default: [] editEntitiesDenied: type: array items: type: string format: uuid default: [] '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: updateEntitlement tags: - Entitlements description: Method to update or create entitlements for a user. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. requestBody: description: The Entitlement to use for the update. content: application/json: schema: type: object properties: viewVip: type: boolean nullable: false default: false editVip: type: boolean nullable: false default: false viewInsiderRoles: type: array items: type: string format: uuid default: [] editInsiderRoles: type: array items: type: string format: uuid default: [] viewEntitiesAllowed: type: array items: type: string format: uuid default: [] editEntitiesAllowed: type: array items: type: string format: uuid default: [] viewEntitiesDenied: type: array items: type: string format: uuid default: [] editEntitiesDenied: type: array items: type: string format: uuid default: [] responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteEntitlement tags: - Entitlements description: Method to delete entitlements for a user. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. responses: '204': description: No Content - Successful delete. '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/screenings': post: operationId: createScreening tags: - Screenings description: Method to add a Screening to an Entity. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityId: type: string format: uuid description: Unique identifier of the Entity. nullable: true createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: listScreenings tags: - Screenings description: >- Method to retrieve an array of Screening resources by the Entity's unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: screenings: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityId: type: string format: uuid description: Unique identifier of the Entity. nullable: true createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/screenings': post: operationId: postCreateScreening tags: - Screenings description: Method to Post an Entity for a Screening. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. requestBody: description: Entity resource to be created. content: application/json: schema: required: - addresses allOf: - type: object required: - entityType - taxIdType - entitySubtypeId - lastName - taxInformation properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityType: type: string description: | This attribute identifies the entity type. nullable: false enum: - Individual - Nonindividual entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: > If `IsEntitySubtypeMandatory` of `EntitySettings` is true, this property must have an Id value. The entity subtype must also be valid for the entity type based on `EntityTypesApplicable` settings. taxIdType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: > The tax id type must be valid for the entity type based on `EntityTypesApplicable` settings. taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: | Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 suffix: type: string description: >- This attribute defines the suffix that should follow the name of the entity. nullable: true maxLength: 31 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 foreignEntity: type: boolean description: >- This attribute designates whether the entity is a US person/Org or not. nullable: true default: false foreignTaxIdNumber: type: string description: > This attribute specifies the foreign Taxpayer Identification Number used for tax purposes in the country of residence. It will be utilized for 1042-S reporting. Must consist only of alphanumeric characters. maxLength: 25 nullable: true insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false startDate: type: string format: date description: > This attribute defines either the birth date of Individual or the start date of Nonindividual. Must be a current date or past date. nullable: true endDate: type: string format: date description: > This attribute defines either the deceased date of Individual or the end date of Nonindividual. Must be a current date or past date. nullable: true entityOfficerId: type: string format: uuid description: >- This attribute defines the primary officer Id associated to entity's account. nullable: true entityBranchAddressId: type: string format: uuid description: >- This attribute defines the branch Id associated to entity's account. nullable: true natureOfBusiness: type: string description: > This attribute defines the nature of business for the entity. It is a free-form text field that describes the primary business activity of the entity. nullable: true maxLength: 255 taxReturnDate: type: string format: date-time description: | This attribute defines the commercial tax return date. Must be a current date or past date. nullable: true ficoScore: type: string format: numeric only description: > This attribute is the FICO score of the entity. A numerical representation of the credit risk that helps FIs decide whether to approve loans or credit cards. minLength: 3 maxLength: 3 netWorth: description: > This attribute specifies the net worth currency value of the entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false gender: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. pronoun: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. race: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. ethnicity: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. disability: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. incomeLevel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. militaryInformation: allOf: - type: object description: >- The military information associated with this entity. properties: status: type: string description: >- This attribute indicates the military status of this entity. nullable: true enum: - Active Duty - Reserve - Inactive - Dependent activeDutyVerificationDate: type: string format: date description: >- This is the date active duty status was verified. nullable: true activeDutyStartDate: type: string format: date description: >- This date indicates the start date of active duty status. nullable: true activeDutySeparationDate: type: string format: date description: >- This date indicates the separation date from active duty status. nullable: true nullable: true - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true privacyOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Privacy Opt Out options. This value can only be set to true if the Institution's entity settings `AllowPrivacyOptOutAll` value is true. nullable: true default: false privacyActLastNoticeDate: type: string format: date-time description: > The timestamp of when the entity was last notified about the Privacy Act. Must be current date or a past date. nullable: true affiliateOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Affiliate Opt Out options. This value can only be set to true if the Institution's entity settings AllowAffiliateOptOutAll value is true. nullable: true default: false includeLegalEntity: type: boolean description: > This attribute represents the entity's inclusion to the FinCEN Customer Due Diligence (CDD) processes. If the value is set as false, the legal entity exclusion reason must be provided. nullable: true default: false legalEntityExclusionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- The attribute is required when `includeLegalEntity` is set to `false`. legalEntityId: type: string description: >- A unique alphanumeric identifier for legal entities participating in financial transactions. nullable: true maxLength: 20 taxInformation: type: object required: - irsReportable properties: taxIdCertificationStatus: type: string description: The status of the Tax Id certification. nullable: true enum: - IRS has generated B notice - Entity has certified the TIN provided - TIN certificate has been sent to entity taxIdCertificationDate: type: string format: date description: | The date the Tax Id was certified. Must be a current date or past date. nullable: true bNoticesSent: type: number format: int32 default: 0 description: | The number of B Notices sent to the Entity. Valid values: 0, 1, 2 nullable: true lastBNoticeDate: type: string format: date description: | The date the last B Notice was sent to the Entity. Must be a current date or past date. nullable: true irsReportable: type: string description: Indicates how the Entity will report to the IRS. nullable: false enum: - IRS Reportable - Foreign IRS Reportable - Non-IRS Reportable foreignEntityInformation: type: object properties: citizenshipCountry: type: object properties: alpha2: description: > Must be a valid ISO 3166-1 alpha-2 country code that should be present in `CountryCode` settings. type: string minLength: 2 maxLength: 2 nullable: false reportingChapter: type: string description: The Reporting Chapter used by the Entity. nullable: true enum: - Chapter 3 - Chapter 4 chapterExemption: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false chapterStatus: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false foreignCertificationInformation: type: object properties: w8Type: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false w8CertificationDate: type: string format: date description: | The date the W8 Form was certified. Must be a current date or past date. nullable: true w8ExpirationDate: type: string format: date description: | The date the W8 Form expires. Must be a future date. nullable: true giinId: type: string description: | The GIIN Id used by the Entity. nullable: true maxLength: 19 giinProvidedDate: type: string format: date description: | The date the GIIN was provided. Must be a current date or past date. nullable: true giinCertificationDate: type: string format: date description: | The date the GIIN was certified. Must be a current date or past date. nullable: true commercial: type: object properties: sicCode: type: string format: numeric only description: >- This attribute defines the Standard Industrial Classification (SIC) code used to classify the commercial entity by industry. minLength: 4 maxLength: 4 naicsCode: type: string format: numeric only description: >- This attribute defines the North American Industry Classification System (NAICS) code used to categorize the commercial entity based on primary economic activity. minLength: 4 maxLength: 4 grossAnnualRevenue: description: > This attribute specifies the gross annual revenue of a commercial entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false financialStatementDate: type: string format: date description: > This attribute defines the commercial financial statement date. Must be a current date or past date. nullable: true createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true - type: object properties: addresses: type: array description: > An array of addresses for the entity. To create an entity, at least one address is required in the addresses list, and one of the addresses must be a mailing address. More than one Tax Address or Mailing Address is not allowed. nullable: false items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array minItems: 1 description: | The individual lines of the address. At least one line is required. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. For US addresses, it will be validated against a valid ISO 3166-2 code. For non-US addresses, it will not be validated. nullable: true maxLength: 63 postalCode: type: string description: | The postal code linked to the address. It should be an alphanumeric value. nullable: false maxLength: 11 county: type: string description: > The County for the address. Valid for US addresses only. If the state value is provided, this attribute value must be valid for the state as per the state's FIPS code. nullable: true maxLength: 255 country: type: string description: > The ISO Alpha-2 country code. Defaults to 'US' if not provided. It will be validated for existence against the `CountryCode` settings if the value is not the default "US". The value will be capitalized. nullable: true default: US maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: | The time zone in which the address is located. Alpha Only characters allowed. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 isMailing: type: boolean description: | Indicates this as a mailing address. Only one address can be set as a mailing address. nullable: true default: false isTax: type: boolean description: | Indicates this as a tax address. Only one address can be set as a tax address. nullable: true default: false seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false phoneNumbers: type: array description: An array of phone numbers for the entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: > Internal phone extension designation for a multi-line phone number. Numeric only. nullable: true maxLength: 10 countryCallingCode: type: string description: > International country code with omitted prefix. Numeric only. nullable: true label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: The Id must be a valid Phone Number Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false isPreferredContactText: type: boolean description: > Indicates the Phone Number is the preferred method for text communication to be used for the Entity. This property is only available when creating an Entity. Only one Phone Number can be preferred text. isPreferredContactVoice: type: boolean description: > Indicates the Phone Number is the preferred method for voice communication to be used for the Entity. This property is only available when creating an Entity. Only one Phone Number can be preferred voice. digitalContactPoints: type: array description: An array of digital contact points for the entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: >- The Id must be a valid Digital Contact Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false isPreferredContactEmail: type: boolean description: > Indicates the Digital Contact Point is the preferred email address to be used for the Entity. This property is only available when creating an Entity. The Digital Contact Point Type must be "Email" and only one email address can be preferred. identifications: type: array description: > An array of Identification related information used to verify an entity's identity. Duplicate values are not allowed in the list. It must not be empty when `IsIdentificationMandatory` of `EntitySettings` is true. nullable: true items: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: required: - id description: | The Id must be a valid Identification Type Id. allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true privacyOptOuts: type: array description: | An array of Privacy Opt Out options. Duplicate values are not allowed in the list. nullable: true items: type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the Opt Out Type. value: description: > If the value is null, it will be set with the default value of `PrivacyOptOutType` settings. If the value is true and `PrivacyOptOutType.NoOptOut` settings is true, it will return an error indicating the `Opt out type` cannot be opted out of. type: boolean affiliateOptOuts: type: array description: | An array of Affiliate Opt Out options. Duplicate values are not allowed in the list. nullable: true items: type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the Opt Out Type. value: description: > If the value is null, it will be set with the default value of `AffiliateOptOutType` settings. If the value is true and `AffiliateOptOutType.NoOptOut` settings is true, it will return an error indicating the `Opt out type` cannot be opted out of. type: boolean exceptionReason: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false exceptionDate: type: string format: date description: | The date when the Opt Out Exception takes effect. Date must be current date or a future date. nullable: true revokeDate: type: string format: date description: | The date when the Opt Out is to be revoked. Date must be a current date or a future date. nullable: true employments: type: array description: An array of Employments for the entity. nullable: true items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: >- This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: >- This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityId: type: string format: uuid description: Unique identifier of the Entity. nullable: true createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/addresses-changes': get: operationId: listAddressChanges tags: - Archives description: >- Method to retrieve an array of Address Archive resources by the Entity's unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: addressChanges: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityId: type: string format: uuid description: Unique identifier of the Entity. nullable: true userId: type: string format: uuid description: Unique identifier of the user. nullable: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false isTax: type: boolean description: | Indicates this as a tax address. Only one address can be set as a tax address. nullable: true default: false isMailing: type: boolean description: | Indicates this as a mailing address. Only one address can be set as a mailing address. nullable: true default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: The time zone in which the address is located. nullable: true maxLength: 5 timeStamp: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/phone-numbers-changes': get: operationId: listPhoneNumberChanges tags: - Archives description: >- Method to retrieve an array of Phone Numbers Archive resources by the Entity's unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: phoneChanges: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityId: type: string format: uuid description: Unique identifier of the Entity. nullable: true userId: type: string format: uuid description: Unique identifier of the user. nullable: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false timeStamp: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/entities/{entityId}/digital-contact-points-changes': get: operationId: listContactChanges tags: - Archives description: >- Method to retrieve an array of Digital Contact Point Archive resources by the Entity's unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: contactChanges: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityId: type: string format: uuid description: Unique identifier of the Entity. nullable: true userId: type: string format: uuid description: Unique identifier of the user. nullable: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false timeStamp: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities': post: operationId: createEntity1 tags: - Entities description: Method to add an Entity resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: X-Override-Duplicate-Tax-Id-Number description: >- Indicates whether to override duplicate tax ID number check. Default is false. in: header schema: type: boolean default: false requestBody: description: Entity resource to be created. content: application/json: schema: required: - addresses allOf: - type: object required: - entityType - taxIdType - entitySubtypeId - lastName - taxInformation properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityType: type: string description: | This attribute identifies the entity type. nullable: false enum: - Individual - Nonindividual entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: > If `IsEntitySubtypeMandatory` of `EntitySettings` is true, this property must have an Id value. The entity subtype must also be valid for the entity type based on `EntityTypesApplicable` settings. taxIdType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: > The tax id type must be valid for the entity type based on `EntityTypesApplicable` settings. taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: | Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 suffix: type: string description: >- This attribute defines the suffix that should follow the name of the entity. nullable: true maxLength: 31 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 foreignEntity: type: boolean description: >- This attribute designates whether the entity is a US person/Org or not. nullable: true default: false foreignTaxIdNumber: type: string description: > This attribute specifies the foreign Taxpayer Identification Number used for tax purposes in the country of residence. It will be utilized for 1042-S reporting. Must consist only of alphanumeric characters. maxLength: 25 nullable: true insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false startDate: type: string format: date description: > This attribute defines either the birth date of Individual or the start date of Nonindividual. Must be a current date or past date. nullable: true endDate: type: string format: date description: > This attribute defines either the deceased date of Individual or the end date of Nonindividual. Must be a current date or past date. nullable: true entityOfficerId: type: string format: uuid description: >- This attribute defines the primary officer Id associated to entity's account. nullable: true entityBranchAddressId: type: string format: uuid description: >- This attribute defines the branch Id associated to entity's account. nullable: true natureOfBusiness: type: string description: > This attribute defines the nature of business for the entity. It is a free-form text field that describes the primary business activity of the entity. nullable: true maxLength: 255 taxReturnDate: type: string format: date-time description: | This attribute defines the commercial tax return date. Must be a current date or past date. nullable: true ficoScore: type: string format: numeric only description: > This attribute is the FICO score of the entity. A numerical representation of the credit risk that helps FIs decide whether to approve loans or credit cards. minLength: 3 maxLength: 3 netWorth: description: > This attribute specifies the net worth currency value of the entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false gender: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. pronoun: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. race: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. ethnicity: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. disability: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. incomeLevel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. militaryInformation: allOf: - type: object description: >- The military information associated with this entity. properties: status: type: string description: >- This attribute indicates the military status of this entity. nullable: true enum: - Active Duty - Reserve - Inactive - Dependent activeDutyVerificationDate: type: string format: date description: >- This is the date active duty status was verified. nullable: true activeDutyStartDate: type: string format: date description: >- This date indicates the start date of active duty status. nullable: true activeDutySeparationDate: type: string format: date description: >- This date indicates the separation date from active duty status. nullable: true nullable: true - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true privacyOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Privacy Opt Out options. This value can only be set to true if the Institution's entity settings `AllowPrivacyOptOutAll` value is true. nullable: true default: false privacyActLastNoticeDate: type: string format: date-time description: > The timestamp of when the entity was last notified about the Privacy Act. Must be current date or a past date. nullable: true affiliateOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Affiliate Opt Out options. This value can only be set to true if the Institution's entity settings AllowAffiliateOptOutAll value is true. nullable: true default: false includeLegalEntity: type: boolean description: > This attribute represents the entity's inclusion to the FinCEN Customer Due Diligence (CDD) processes. If the value is set as false, the legal entity exclusion reason must be provided. nullable: true default: false legalEntityExclusionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- The attribute is required when `includeLegalEntity` is set to `false`. legalEntityId: type: string description: >- A unique alphanumeric identifier for legal entities participating in financial transactions. nullable: true maxLength: 20 taxInformation: type: object required: - irsReportable properties: taxIdCertificationStatus: type: string description: The status of the Tax Id certification. nullable: true enum: - IRS has generated B notice - Entity has certified the TIN provided - TIN certificate has been sent to entity taxIdCertificationDate: type: string format: date description: | The date the Tax Id was certified. Must be a current date or past date. nullable: true bNoticesSent: type: number format: int32 default: 0 description: | The number of B Notices sent to the Entity. Valid values: 0, 1, 2 nullable: true lastBNoticeDate: type: string format: date description: | The date the last B Notice was sent to the Entity. Must be a current date or past date. nullable: true irsReportable: type: string description: Indicates how the Entity will report to the IRS. nullable: false enum: - IRS Reportable - Foreign IRS Reportable - Non-IRS Reportable foreignEntityInformation: type: object properties: citizenshipCountry: type: object properties: alpha2: description: > Must be a valid ISO 3166-1 alpha-2 country code that should be present in `CountryCode` settings. type: string minLength: 2 maxLength: 2 nullable: false reportingChapter: type: string description: The Reporting Chapter used by the Entity. nullable: true enum: - Chapter 3 - Chapter 4 chapterExemption: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false chapterStatus: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false foreignCertificationInformation: type: object properties: w8Type: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false w8CertificationDate: type: string format: date description: | The date the W8 Form was certified. Must be a current date or past date. nullable: true w8ExpirationDate: type: string format: date description: | The date the W8 Form expires. Must be a future date. nullable: true giinId: type: string description: | The GIIN Id used by the Entity. nullable: true maxLength: 19 giinProvidedDate: type: string format: date description: | The date the GIIN was provided. Must be a current date or past date. nullable: true giinCertificationDate: type: string format: date description: | The date the GIIN was certified. Must be a current date or past date. nullable: true commercial: type: object properties: sicCode: type: string format: numeric only description: >- This attribute defines the Standard Industrial Classification (SIC) code used to classify the commercial entity by industry. minLength: 4 maxLength: 4 naicsCode: type: string format: numeric only description: >- This attribute defines the North American Industry Classification System (NAICS) code used to categorize the commercial entity based on primary economic activity. minLength: 4 maxLength: 4 grossAnnualRevenue: description: > This attribute specifies the gross annual revenue of a commercial entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false financialStatementDate: type: string format: date description: > This attribute defines the commercial financial statement date. Must be a current date or past date. nullable: true createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true - type: object properties: addresses: type: array description: > An array of addresses for the entity. To create an entity, at least one address is required in the addresses list, and one of the addresses must be a mailing address. More than one Tax Address or Mailing Address is not allowed. nullable: false items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array minItems: 1 description: | The individual lines of the address. At least one line is required. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. For US addresses, it will be validated against a valid ISO 3166-2 code. For non-US addresses, it will not be validated. nullable: true maxLength: 63 postalCode: type: string description: | The postal code linked to the address. It should be an alphanumeric value. nullable: false maxLength: 11 county: type: string description: > The County for the address. Valid for US addresses only. If the state value is provided, this attribute value must be valid for the state as per the state's FIPS code. nullable: true maxLength: 255 country: type: string description: > The ISO Alpha-2 country code. Defaults to 'US' if not provided. It will be validated for existence against the `CountryCode` settings if the value is not the default "US". The value will be capitalized. nullable: true default: US maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: | The time zone in which the address is located. Alpha Only characters allowed. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 isMailing: type: boolean description: | Indicates this as a mailing address. Only one address can be set as a mailing address. nullable: true default: false isTax: type: boolean description: | Indicates this as a tax address. Only one address can be set as a tax address. nullable: true default: false seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false phoneNumbers: type: array description: An array of phone numbers for the entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: > Internal phone extension designation for a multi-line phone number. Numeric only. nullable: true maxLength: 10 countryCallingCode: type: string description: > International country code with omitted prefix. Numeric only. nullable: true label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: The Id must be a valid Phone Number Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false isPreferredContactText: type: boolean description: > Indicates the Phone Number is the preferred method for text communication to be used for the Entity. This property is only available when creating an Entity. Only one Phone Number can be preferred text. isPreferredContactVoice: type: boolean description: > Indicates the Phone Number is the preferred method for voice communication to be used for the Entity. This property is only available when creating an Entity. Only one Phone Number can be preferred voice. digitalContactPoints: type: array description: An array of digital contact points for the entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: >- The Id must be a valid Digital Contact Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false isPreferredContactEmail: type: boolean description: > Indicates the Digital Contact Point is the preferred email address to be used for the Entity. This property is only available when creating an Entity. The Digital Contact Point Type must be "Email" and only one email address can be preferred. identifications: type: array description: > An array of Identification related information used to verify an entity's identity. Duplicate values are not allowed in the list. It must not be empty when `IsIdentificationMandatory` of `EntitySettings` is true. nullable: true items: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: required: - id description: | The Id must be a valid Identification Type Id. allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true privacyOptOuts: type: array description: | An array of Privacy Opt Out options. Duplicate values are not allowed in the list. nullable: true items: type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the Opt Out Type. value: description: > If the value is null, it will be set with the default value of `PrivacyOptOutType` settings. If the value is true and `PrivacyOptOutType.NoOptOut` settings is true, it will return an error indicating the `Opt out type` cannot be opted out of. type: boolean affiliateOptOuts: type: array description: | An array of Affiliate Opt Out options. Duplicate values are not allowed in the list. nullable: true items: type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the Opt Out Type. value: description: > If the value is null, it will be set with the default value of `AffiliateOptOutType` settings. If the value is true and `AffiliateOptOutType.NoOptOut` settings is true, it will return an error indicating the `Opt out type` cannot be opted out of. type: boolean exceptionReason: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false exceptionDate: type: string format: date description: | The date when the Opt Out Exception takes effect. Date must be current date or a future date. nullable: true revokeDate: type: string format: date description: | The date when the Opt Out is to be revoked. Date must be a current date or a future date. nullable: true employments: type: array description: An array of Employments for the entity. nullable: true items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: >- This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: >- This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities-search': post: tags: - Entities description: Method to search for one or more Entity resources. operationId: searchEntity1 parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: offset in: query required: false description: >- When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. example: '?offset=50' schema: type: string default: '0' - schema: type: string default: '50' name: count in: query required: false description: >- The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: '?count=100' - name: includeTotals in: query description: Total related accounts returned. schema: type: boolean default: false requestBody: description: Search parameters for Entity. content: application/json: schema: type: object description: > This element is used to search for an Entity using different address components such as Name, Tax Id Number, Phone Number, Digital Contact Point and Address. Atleast one of `taxIdNumber`, `phoneNumber`, `digitalContactPoint`, `address` or `name` element must contain a value. properties: taxIdNumber: type: string description: > This element identifies the value used to search for an Entity by Tax Id Number. Matching Entities Tax Id Number Identifiers must contain value presented. It must contain only numeric characters. nullable: true minLength: 3 name: type: string description: > This element identifies the value used to search for an Entity by name. All name fields identified in `nameSearchFields` element will be searched. nullable: true minLength: 3 phoneNumber: type: string description: > This element identifies the value used to search for an Entity by Phone Number. Matching Entities Phone Numbers must contain value presented. Must be a numeric value. nullable: true minLength: 3 digitalContactPoint: type: string description: > This element identifies the value used to search for an Entity by Digital Contact Point. Matching Entities Digital Contact Point Identifiers must contain value presented. nullable: true minLength: 3 address: type: string description: > This element is used to search for an Entity using different address components. Accepts any alphanumeric value. String separators will be stripped out and not included with search terms. nullable: true minLength: 3 maxLength: 1024 responses: '200': description: Successful search. content: application/json: schema: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: listEntitySearch1 tags: - Entities description: >- Method to retrieve an array of Entity resources from query parameters containing Entity unique identifiers. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityIds in: query description: Identifies the Entities to list. schema: type: array items: type: string format: uuid - name: includeTotals in: query description: Total related accounts returned. schema: type: boolean default: false responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities-search-autocomplete': get: tags: - Entities description: > Method to search for entity names based on the name query parameter. Returns best-matching entity names based on full or partial text matches. At least 3 characters must be provided in the name parameter to return results. Queries with fewer than 3 characters will not return any entity names. The number of returned entity names is controlled by the count parameter: - If count is not provided, returns default 20 matching entity names. - If count is less than 5, minimum of 5 entity names will be returned. - Maximum of 100 entity names can be returned regardless of count value. operationId: searchEntitiesAutoComplete1 parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: name in: query description: > Partial entity name used for autocomplete search functionality. Returns matching entity names that contain or start with the provided value. At least 3 characters must be provided to return results. Queries with fewer than 3 characters will not return any entities. schema: type: string - description: > The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return 20 (default) records. If the count is less than 5, it will be set to 5. If the count is greater than 100, it will be set to 100. schema: type: integer default: 20 maximum: 100 name: count in: query required: false example: '?count=100' responses: '200': description: Successful search. content: application/json: schema: type: object properties: entities: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true name: type: string description: The name of the entity. nullable: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{id}': get: operationId: getEntity1 tags: - Entities description: Method to retrieve an Entity resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object required: - entityType - taxIdType - entitySubtypeId - lastName - taxInformation properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityType: type: string description: | This attribute identifies the entity type. nullable: false enum: - Individual - Nonindividual entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false tinRequired: type: boolean description: Indicates if a tax id number is required. nullable: true default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: | Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 suffix: type: string description: >- This attribute defines the suffix that should follow the name of the entity. nullable: true maxLength: 31 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 foreignEntity: type: boolean description: >- This attribute designates whether the entity is a US person/Org or not. nullable: true default: false foreignTaxIdNumber: type: string description: > This attribute specifies the foreign Taxpayer Identification Number used for tax purposes in the country of residence. It will be utilized for 1042-S reporting. Must consist only of alphanumeric characters. maxLength: 25 nullable: true insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false startDate: type: string format: date description: > This attribute defines either the birth date of Individual or the start date of Nonindividual. Must be a current date or past date. nullable: true endDate: type: string format: date description: > This attribute defines either the deceased date of Individual or the end date of Nonindividual. Must be a current date or past date. nullable: true entityOfficerId: type: string format: uuid description: >- This attribute defines the primary officer Id associated to entity's account. nullable: true entityBranchAddressId: type: string format: uuid description: >- This attribute defines the branch Id associated to entity's account. nullable: true netWorth: description: > This attribute specifies the net worth currency value of the entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false gender: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false pronoun: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false race: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ethnicity: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false disability: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false incomeLevel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name - sortOrder properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false sortOrder: type: integer description: Indicates the sort order of the resource. militaryInformation: type: object description: The military information associated with this entity. properties: status: type: string description: >- This attribute indicates the military status of this entity. nullable: true enum: - Active Duty - Reserve - Inactive - Dependent activeDutyVerificationDate: type: string format: date description: This is the date active duty status was verified. nullable: true activeDutyStartDate: type: string format: date description: >- This date indicates the start date of active duty status. nullable: true activeDutySeparationDate: type: string format: date description: >- This date indicates the separation date from active duty status. nullable: true nullable: true lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true privacyOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Privacy Opt Out options. This value can only be set to true if the Institution's entity settings `AllowPrivacyOptOutAll` value is true. nullable: true default: false privacyActLastNoticeDate: type: string format: date-time description: > The timestamp of when the entity was last notified about the Privacy Act. Must be current date or a past date. nullable: true affiliateOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Affiliate Opt Out options. This value can only be set to true if the Institution's entity settings AllowAffiliateOptOutAll value is true. nullable: true default: false includeLegalEntity: type: boolean description: > This attribute represents the entity's inclusion to the FinCEN Customer Due Diligence (CDD) processes. If the value is set as false, the legal entity exclusion reason must be provided. nullable: true default: false legalEntityExclusionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false legalEntityId: type: string description: >- A unique alphanumeric identifier for legal entities participating in financial transactions. nullable: true maxLength: 20 taxInformation: type: object required: - irsReportable properties: taxIdCertificationStatus: type: string description: The status of the Tax Id certification. nullable: true enum: - IRS has generated B notice - Entity has certified the TIN provided - TIN certificate has been sent to entity taxIdCertificationDate: type: string format: date description: | The date the Tax Id was certified. Must be a current date or past date. nullable: true bNoticesSent: type: number format: int32 default: 0 description: | The number of B Notices sent to the Entity. Valid values: 0, 1, 2 nullable: true lastBNoticeDate: type: string format: date description: | The date the last B Notice was sent to the Entity. Must be a current date or past date. nullable: true irsReportable: type: string description: Indicates how the Entity will report to the IRS. nullable: false enum: - IRS Reportable - Foreign IRS Reportable - Non-IRS Reportable foreignEntityInformation: type: object properties: citizenshipCountry: type: object properties: numeric: type: string description: >- The unique ISO three numeric character code for the Country. minLength: 3 maxLength: 3 nullable: false alpha2: type: string description: >- The unique ISO two Alpha character code for the Country. minLength: 2 maxLength: 2 nullable: false alpha3: type: string description: >- The unique ISO three Alpha character code for the Country. Must contain 3 alpha characters. minLength: 3 maxLength: 3 nullable: false name: type: string description: The full name of the Country. maxLength: 255 nullable: false reportingChapter: type: string description: The Reporting Chapter used by the Entity. nullable: true enum: - Chapter 3 - Chapter 4 chapterExemption: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. chapterStatus: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. foreignCertificationInformation: type: object properties: w8Type: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 w8CertificationDate: type: string format: date description: | The date the W8 Form was certified. Must be a current date or past date. nullable: true w8ExpirationDate: type: string format: date description: | The date the W8 Form expires. Must be a future date. nullable: true giinId: type: string description: | The GIIN Id used by the Entity. nullable: true maxLength: 19 giinProvidedDate: type: string format: date description: | The date the GIIN was provided. Must be a current date or past date. nullable: true giinCertificationDate: type: string format: date description: | The date the GIIN was certified. Must be a current date or past date. nullable: true preferredContactVoiceId: type: string description: > The Id of the preferred phone number for voice calls. The value must reference an existing Phone Number for the Entity. nullable: true format: uuid preferredContactTextId: type: string description: > The Id of the preferred phone number for text messages. The value must reference an existing Phone Number for the Entity. nullable: true format: uuid preferredContactEmailId: type: string description: > The Id of the preferred contact method for emails. The value must reference an existing Digital Contact Point of Type 'Email' for the Entity. nullable: true format: uuid taxAddressId: type: string description: The Id of the tax address. nullable: true format: uuid mailingAddressId: type: string description: The Id of the mailing address. nullable: true format: uuid commercial: type: object properties: sicCode: type: string format: numeric only description: >- This attribute defines the Standard Industrial Classification (SIC) code used to classify the commercial entity by industry. minLength: 4 maxLength: 4 naicsCode: type: string format: numeric only description: >- This attribute defines the North American Industry Classification System (NAICS) code used to categorize the commercial entity based on primary economic activity. minLength: 4 maxLength: 4 grossAnnualRevenue: description: > This attribute specifies the gross annual revenue of a commercial entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false financialStatementDate: type: string format: date description: > This attribute defines the commercial financial statement date. Must be a current date or past date. nullable: true createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true addresses: type: array description: An array of addresses for the entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false phoneNumbers: type: array description: An array of phone numbers for the entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false identifications: type: array description: >- An array of Identification related information used to verify an entity's identity. nullable: true items: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: required: - id description: | The Id must be a valid Identification Type Id. allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true privacyOptOuts: type: array description: An array of Privacy Opt Out options. nullable: true items: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: >- Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false affiliateOptOuts: type: array description: An array of Affiliate Opt Out options. nullable: true items: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. exceptionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false exceptionDate: type: string format: date description: > The date when the Opt Out Exception takes effect. Date must be current date or a future date. nullable: true revokeDate: type: string format: date description: | The date when the Opt Out is to be revoked. Date must be a current date or a future date. nullable: true - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: >- Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false employments: type: array description: An array of Employments for the entity. nullable: true items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: >- This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: >- This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 ficoScore: type: string format: numeric only description: > This attribute is the FICO score of the entity. A numerical representation of the credit risk that helps FIs decide whether to approve loans or credit cards. minLength: 3 maxLength: 3 taxReturnDate: type: string format: date-time description: | This attribute defines the commercial tax return date. Must be a current date or past date. nullable: true natureOfBusiness: type: string description: > This attribute defines the nature of business for the entity. It is a free-form text field that describes the primary business activity of the entity. nullable: true maxLength: 255 '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceEntity1 tags: - Entities description: Method to update an Entity resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid - name: X-Override-Duplicate-Tax-Id-Number description: >- Indicates whether to override duplicate tax ID number check. Default is false. in: header schema: type: boolean default: false requestBody: description: Entity resource to be updated. content: application/json: schema: allOf: - type: object required: - entityType - taxIdType - entitySubtypeId - lastName - taxInformation properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityType: type: string description: | This attribute identifies the entity type. nullable: false enum: - Individual - Nonindividual entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: > If `IsEntitySubtypeMandatory` of `EntitySettings` is true, this property must have an Id value. The entity subtype must also be valid for the entity type based on `EntityTypesApplicable` settings. taxIdType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: > The tax id type must be valid for the entity type based on `EntityTypesApplicable` settings. taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: | Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 suffix: type: string description: >- This attribute defines the suffix that should follow the name of the entity. nullable: true maxLength: 31 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 foreignEntity: type: boolean description: >- This attribute designates whether the entity is a US person/Org or not. nullable: true default: false foreignTaxIdNumber: type: string description: > This attribute specifies the foreign Taxpayer Identification Number used for tax purposes in the country of residence. It will be utilized for 1042-S reporting. Must consist only of alphanumeric characters. maxLength: 25 nullable: true insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false startDate: type: string format: date description: > This attribute defines either the birth date of Individual or the start date of Nonindividual. Must be a current date or past date. nullable: true endDate: type: string format: date description: > This attribute defines either the deceased date of Individual or the end date of Nonindividual. Must be a current date or past date. nullable: true entityOfficerId: type: string format: uuid description: >- This attribute defines the primary officer Id associated to entity's account. nullable: true entityBranchAddressId: type: string format: uuid description: >- This attribute defines the branch Id associated to entity's account. nullable: true natureOfBusiness: type: string description: > This attribute defines the nature of business for the entity. It is a free-form text field that describes the primary business activity of the entity. nullable: true maxLength: 255 taxReturnDate: type: string format: date-time description: | This attribute defines the commercial tax return date. Must be a current date or past date. nullable: true ficoScore: type: string format: numeric only description: > This attribute is the FICO score of the entity. A numerical representation of the credit risk that helps FIs decide whether to approve loans or credit cards. minLength: 3 maxLength: 3 netWorth: description: > This attribute specifies the net worth currency value of the entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false gender: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. pronoun: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. race: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. ethnicity: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. disability: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. incomeLevel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. militaryInformation: allOf: - type: object description: >- The military information associated with this entity. properties: status: type: string description: >- This attribute indicates the military status of this entity. nullable: true enum: - Active Duty - Reserve - Inactive - Dependent activeDutyVerificationDate: type: string format: date description: >- This is the date active duty status was verified. nullable: true activeDutyStartDate: type: string format: date description: >- This date indicates the start date of active duty status. nullable: true activeDutySeparationDate: type: string format: date description: >- This date indicates the separation date from active duty status. nullable: true nullable: true - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true privacyOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Privacy Opt Out options. This value can only be set to true if the Institution's entity settings `AllowPrivacyOptOutAll` value is true. nullable: true default: false privacyActLastNoticeDate: type: string format: date-time description: > The timestamp of when the entity was last notified about the Privacy Act. Must be current date or a past date. nullable: true affiliateOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Affiliate Opt Out options. This value can only be set to true if the Institution's entity settings AllowAffiliateOptOutAll value is true. nullable: true default: false includeLegalEntity: type: boolean description: > This attribute represents the entity's inclusion to the FinCEN Customer Due Diligence (CDD) processes. If the value is set as false, the legal entity exclusion reason must be provided. nullable: true default: false legalEntityExclusionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- The attribute is required when `includeLegalEntity` is set to `false`. legalEntityId: type: string description: >- A unique alphanumeric identifier for legal entities participating in financial transactions. nullable: true maxLength: 20 taxInformation: type: object required: - irsReportable properties: taxIdCertificationStatus: type: string description: The status of the Tax Id certification. nullable: true enum: - IRS has generated B notice - Entity has certified the TIN provided - TIN certificate has been sent to entity taxIdCertificationDate: type: string format: date description: | The date the Tax Id was certified. Must be a current date or past date. nullable: true bNoticesSent: type: number format: int32 default: 0 description: | The number of B Notices sent to the Entity. Valid values: 0, 1, 2 nullable: true lastBNoticeDate: type: string format: date description: | The date the last B Notice was sent to the Entity. Must be a current date or past date. nullable: true irsReportable: type: string description: Indicates how the Entity will report to the IRS. nullable: false enum: - IRS Reportable - Foreign IRS Reportable - Non-IRS Reportable foreignEntityInformation: type: object properties: citizenshipCountry: type: object properties: alpha2: description: > Must be a valid ISO 3166-1 alpha-2 country code that should be present in `CountryCode` settings. type: string minLength: 2 maxLength: 2 nullable: false reportingChapter: type: string description: The Reporting Chapter used by the Entity. nullable: true enum: - Chapter 3 - Chapter 4 chapterExemption: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false chapterStatus: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false foreignCertificationInformation: type: object properties: w8Type: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false w8CertificationDate: type: string format: date description: | The date the W8 Form was certified. Must be a current date or past date. nullable: true w8ExpirationDate: type: string format: date description: | The date the W8 Form expires. Must be a future date. nullable: true giinId: type: string description: | The GIIN Id used by the Entity. nullable: true maxLength: 19 giinProvidedDate: type: string format: date description: | The date the GIIN was provided. Must be a current date or past date. nullable: true giinCertificationDate: type: string format: date description: | The date the GIIN was certified. Must be a current date or past date. nullable: true commercial: type: object properties: sicCode: type: string format: numeric only description: >- This attribute defines the Standard Industrial Classification (SIC) code used to classify the commercial entity by industry. minLength: 4 maxLength: 4 naicsCode: type: string format: numeric only description: >- This attribute defines the North American Industry Classification System (NAICS) code used to categorize the commercial entity based on primary economic activity. minLength: 4 maxLength: 4 grossAnnualRevenue: description: > This attribute specifies the gross annual revenue of a commercial entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false financialStatementDate: type: string format: date description: > This attribute defines the commercial financial statement date. Must be a current date or past date. nullable: true createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true - type: object properties: preferredContactVoiceId: type: string description: > The Id of the preferred phone number for voice calls. The value must reference an existing Phone Number for the Entity. nullable: true format: uuid preferredContactTextId: type: string description: > The Id of the preferred phone number for text messages. The value must reference an existing Phone Number for the Entity. nullable: true format: uuid preferredContactEmailId: type: string description: > The Id of the preferred contact method for emails. The value must reference an existing Digital Contact Point of Type 'Email' for the Entity. nullable: true format: uuid taxAddressId: type: string description: The Id of the tax address. nullable: true format: uuid mailingAddressId: type: string description: The Id of the mailing address. nullable: true format: uuid responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteEntity1 tags: - Entities description: > Method to delete an Entity resource. The deletion will only proceed if all associated relationships have been deleted beforehand. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{entityId}/addresses': post: operationId: createAddress1 tags: - Addresses description: Method to add an Address to an Entity. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid requestBody: description: The Address to be created. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array minItems: 1 description: | The individual lines of the address. At least one line is required. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. For US addresses, it will be validated against a valid ISO 3166-2 code. For non-US addresses, it will not be validated. nullable: true maxLength: 63 postalCode: type: string description: | The postal code linked to the address. It should be an alphanumeric value. nullable: false maxLength: 11 county: type: string description: > The County for the address. Valid for US addresses only. If the state value is provided, this attribute value must be valid for the state as per the state's FIPS code. nullable: true maxLength: 255 country: type: string description: > The ISO Alpha-2 country code. Defaults to 'US' if not provided. It will be validated for existence against the `CountryCode` settings if the value is not the default "US". The value will be capitalized. nullable: true default: US maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: | The time zone in which the address is located. Alpha Only characters allowed. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 isMailing: type: boolean description: | Indicates this as a mailing address. Only one address can be set as a mailing address. nullable: true default: false isTax: type: boolean description: | Indicates this as a tax address. Only one address can be set as a tax address. nullable: true default: false seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: This attribute defines the end date for Seasonal Addresses. addressLabel: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: listAddress1 tags: - Addresses description: >- Method to retrieve an array of Address resources by the Entity's unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: addresses: type: array items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{entityId}/addresses/{id}': put: operationId: replaceAddress1 tags: - Addresses description: Method to update an Address resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: Address resource to be updated. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array minItems: 1 description: | The individual lines of the address. At least one line is required. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. For US addresses, it will be validated against a valid ISO 3166-2 code. For non-US addresses, it will not be validated. nullable: true maxLength: 63 postalCode: type: string description: | The postal code linked to the address. It should be an alphanumeric value. nullable: false maxLength: 11 county: type: string description: > The County for the address. Valid for US addresses only. If the state value is provided, this attribute value must be valid for the state as per the state's FIPS code. nullable: true maxLength: 255 country: type: string description: > The ISO Alpha-2 country code. Defaults to 'US' if not provided. It will be validated for existence against the `CountryCode` settings if the value is not the default "US". The value will be capitalized. nullable: true default: US maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: | The time zone in which the address is located. Alpha Only characters allowed. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 isMailing: type: boolean description: | Indicates this as a mailing address. Only one address can be set as a mailing address. nullable: true default: false isTax: type: boolean description: | Indicates this as a tax address. Only one address can be set as a tax address. nullable: true default: false seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: This attribute defines the end date for Seasonal Addresses. addressLabel: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: getAddress1 tags: - Addresses description: Method to retrieve an Address resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteAddress1 tags: - Addresses description: > Method to delete an Address resource. Deletion is only allowed if the address is not a tax or mailing address. If the address is a tax or mailing address, it must first be replaced with a new address before deletion. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{entityId}/digital-contact-points': post: operationId: createDigitalContactPoint1 tags: - Digital Contact Points description: Method to add a digital contact point to an Entity. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid requestBody: description: The digital contact point to be created. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: The Id must be a valid Digital Contact Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: listDigitalContactPoint1 tags: - Digital Contact Points description: >- Method to retrieve an array of Phone Number resources by the Entity's unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: digitalContactPoints: type: array items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{entityId}/digital-contact-points/{id}': put: operationId: replaceDigitalContactPoint1 tags: - Digital Contact Points description: Method to update a Phone Number resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: Phone Number resource to be updated. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: The Id must be a valid Digital Contact Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: getDigitalContactPoint1 tags: - Digital Contact Points description: Method to retrieve a Phone Number resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteDigitalContactPoint1 tags: - Digital Contact Points description: > Method to delete a digital contact point resource. If the digital contact point to be deleted is a preferred contact email, it cannot be deleted. A new preferred contact email must be selected before proceeding with the deletion. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{entityId}/phone-numbers': post: operationId: createPhoneNumber1 tags: - Phone Numbers description: Method to add a Phone Number to an Entity. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid requestBody: description: The Phone Number to be created. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: > Internal phone extension designation for a multi-line phone number. Numeric only. nullable: true maxLength: 10 countryCallingCode: type: string description: | International country code with omitted prefix. Numeric only. nullable: true label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: The Id must be a valid Phone Number Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: listPhoneNumber1 tags: - Phone Numbers description: >- Method to retrieve an array of Phone Number resources by the Entity's unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: phoneNumbers: type: array items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{entityId}/phone-numbers/{id}': put: operationId: replacePhoneNumber1 tags: - Phone Numbers description: Method to update a Phone Number resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: Phone Number resource to be updated. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: > Internal phone extension designation for a multi-line phone number. Numeric only. nullable: true maxLength: 10 countryCallingCode: type: string description: | International country code with omitted prefix. Numeric only. nullable: true label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: The Id must be a valid Phone Number Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: getPhoneNumber1 tags: - Phone Numbers description: Method to retrieve a Phone Number resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deletePhoneNumber1 tags: - Phone Numbers description: > Method to delete a Phone Number resource. If the phone number to be deleted is a preferred contact voice id or text id, it cannot be deleted. A new preferred contact voice id or text id must be selected before proceeding with the deletion. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{entityId}/identifications': post: operationId: createIdentification1 tags: - Identifications description: Method to add an Identification to an Entity. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid requestBody: description: The Identification to be created. content: application/json: schema: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: | The Id must be a valid Identification Type Id. idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: listIdentification1 tags: - Identifications description: >- Method to retrieve an array of Identification resources by the Entity's unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: identifications: type: array items: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: required: - id description: | The Id must be a valid Identification Type Id. allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{entityId}/identifications/{id}': put: operationId: replaceIdentification1 tags: - Identifications description: Method to update an Identification resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: Identification resource to be updated. content: application/json: schema: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: | The Id must be a valid Identification Type Id. idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: getIdentification1 tags: - Identifications description: Method to retrieve an Identification resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: required: - id description: | The Id must be a valid Identification Type Id. allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteIdentification1 tags: - Identifications description: > Method to delete an Identification resource. If the `IsIdentificationMandatory` is set to true in settings, then the last entry of Identification cannot be deleted. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{entityId}/privacy-opt-outs': get: operationId: listPrivacyOptOut1 tags: - Privacy Opt Outs description: >- Method to retrieve an array of Privacy Opt Out resources by the Entity's unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: PrivacyOptOuts: type: array items: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: >- Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{entityId}/privacy-opt-outs/{id}': put: operationId: replacePrivacyOptOut1 tags: - Privacy Opt Outs description: Method to update a Privacy Opt Out resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: Privacy Opt Out resource to be updated. content: application/json: schema: type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: getPrivacyOptOut1 tags: - Privacy Opt Outs description: Method to retrieve a Privacy Opt Out resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{entityId}/affiliate-opt-outs': get: operationId: listAffiliateOptOuts1 tags: - Affiliate Opt Outs description: >- Method to retrieve an array of Affiliate Opt Out resources by the Entity's unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: AffiliateOptOuts: type: array items: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. exceptionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false exceptionDate: type: string format: date description: > The date when the Opt Out Exception takes effect. Date must be current date or a future date. nullable: true revokeDate: type: string format: date description: | The date when the Opt Out is to be revoked. Date must be a current date or a future date. nullable: true - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: >- Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{entityId}/affiliate-opt-outs/{id}': put: operationId: replaceAffiliateOptOut1 tags: - Affiliate Opt Outs description: Method to update an Affiliate Opt Out resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: Affiliate Opt Out resource to be updated. content: application/json: schema: type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. exceptionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false exceptionDate: type: string format: date description: | The date when the Opt Out Exception takes effect. Date must be current date or a future date. nullable: true revokeDate: type: string format: date description: | The date when the Opt Out is to be revoked. Date must be a current date or a future date. nullable: true responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: getAffiliateOptOut1 tags: - Affiliate Opt Outs description: >- Method to retrieve an Affiliate Opt Out resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. exceptionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false exceptionDate: type: string format: date description: | The date when the Opt Out Exception takes effect. Date must be current date or a future date. nullable: true revokeDate: type: string format: date description: | The date when the Opt Out is to be revoked. Date must be a current date or a future date. nullable: true - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{entityId}/employments': post: operationId: createEmployment1 tags: - Employments description: Method to add an Employment to an Entity. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid requestBody: description: The Employment to be created. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: >- This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: >- This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: listEmployments1 tags: - Employments description: >- Method to retrieve an array of Employment resources by the Entity's unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: employments: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: >- This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: >- This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/{entityId}/employments/{id}': put: operationId: replaceEmployment1 tags: - Employments description: Method to update an Employment resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: Employment resource to be updated. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: >- This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: >- This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: getEmployment1 tags: - Employments description: Method to retrieve an Employment resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful retrieve. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: >- This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: >- This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteEmployment1 tags: - Employments description: Method to delete an Employment resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: path description: Identifies the Entity to which the resource belongs. required: true schema: type: string format: uuid - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/relationships': post: operationId: createEntityRelationship tags: - Relationships description: Method to add a Relationship resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: Relationship resource to be created. content: application/json: schema: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: | The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/relationships-search': post: operationId: searchEntityRelationships tags: - Relationships description: >- Search for entity relationships using an array of combinations that include entityId, assetId, and assetType parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: offset in: query required: false description: >- When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. example: '?offset=50' schema: type: string default: '0' - schema: type: string default: '1000' name: count in: query required: false description: >- The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: '?count=100' - name: irsReportable in: query description: > If set to true, the response will only give you the IRS Reportable Relationship and Entity Example: `.../relationships-search?IRSReportable=true` required: false schema: type: string default: 'false' requestBody: description: Search parameters for Entity Relationship. content: application/json: schema: type: object properties: entityAssets: type: array description: >- At least one of the entityId or AssetId must be present in each item of the array. Additionally, the AssetType can be either empty, 'Accounts', or 'Cards'. items: type: object properties: entityId: type: string format: uuid description: | The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards responses: '200': description: Successful search. content: application/json: schema: type: object properties: paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: | The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/relationships/{id}': get: operationId: getEntityRelationshipById tags: - Relationships description: Get Entity Relationship by Relationship ID parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: The unique identifier given to a relationship. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: | The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceEntityRelationship tags: - Relationships description: Method to update an Entity Relationship resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: The unique identifier given to a relationship. required: true schema: type: string format: uuid requestBody: description: Entity Relationship resource to be updated. content: application/json: schema: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: | The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteEntityRelationship tags: - Relationships description: Method to delete an Entity Relationship resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error patch: operationId: patchEntityRelationship tags: - Relationships description: > Facilitates the process of switching the IRS reportable entity to another entity, typically in scenarios such as the death of the current IRS reportable entity or an account onboarding error. Only one relationship-asset-entity combination is allowed. Otherwise, the system will return a bad request error indicating that a duplicate entity-relationship-asset association exists. The given relationship ID must be IRS reportable to perform the switch. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: The unique identifier given to a relationship. required: true schema: type: string format: uuid requestBody: content: application/json-patch+json: schema: type: object properties: entityId: type: string format: uuid description: | The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/relationships/relationship-types': get: operationId: listRelationshipTypes tags: - Relationship Types description: >- The endpoint to retrieve all of the Relationship Type resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: relationshipTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createRelationshipType tags: - Relationship Types description: The endpoint to add a Relationship Type resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Relationship Type resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: | This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/relationships/relationship-types/{id}': get: operationId: getRelationshipType tags: - Relationship Types description: >- The endpoint to retrieve a Relationship Type resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: | This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceRelationshipType tags: - Relationship Types description: The endpoint to update a Relationship Type resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Relationship Type resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: | This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteRelationshipType tags: - Relationship Types description: The endpoint to delete a Relationship Type resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/relationships/switch-irs-reportable': post: operationId: switchIrsReportableRelationship tags: - Relationships description: Method to switch the IRS reportable relationship to a new relationship. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: Current and new IRS reportable relationships to be switched. content: application/json: schema: type: object properties: currentIrsReportableRelationship: type: object description: > This object is used to specify the current IRS reportable relationship. It contains the ID of the current IRS reportable relationship. Relationship Type can be specified to update the relationship type of the current IRS reportable relationship. Delete can be specified to delete the current IRS reportable relationship. required: - id properties: id: type: string format: uuid description: >- The unique identifier for the current IRS reportable relationship. nullable: false relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id delete: type: boolean description: | This describes the delete status of this resource. If set to true, the resource will be deleted. If set to false, the resource will not be deleted. nullable: true default: false newIrsReportableRelationship: type: object description: > This object is used to specify the new IRS reportable relationship. It contains the ID of the new IRS reportable relationship. Relationship Type can be specified to update the relationship type of the new IRS reportable relationship. required: - id properties: id: type: string format: uuid description: >- The unique identifier for the new IRS reportable relationship. nullable: false relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/relationships-changes': get: operationId: listRelationshipChangeResponse tags: - Archive Relationships description: > This endpoint is used to retrieve the relationship changes for a specific entity and asset. Either EntityId or AssetId must be provided. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: entityId in: query description: | The unique identifier given to an entity. This value must be an existing entity identifier. This value must be set if the assetId is not set. required: false schema: type: string - name: assetId in: query description: > The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. This value must be set if the entityId is not set. required: false schema: type: string responses: '200': description: Successful get. content: application/json: schema: type: object properties: relationshipChanges: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: | The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 timeStamp: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true operation: type: string description: the archive operation on the resource. maxLength: 255 readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/tax-id-types': get: operationId: listTaxIdTypes tags: - Tax Id Types description: >- The endpoint to retrieve all of the Tax Identification Type resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: taxIdTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false tinRequired: type: boolean description: Indicates if a tax id number is required. nullable: true default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createTaxIdType tags: - Tax Id Types description: >- The endpoint to add a Tax Identification Type resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Tax Identification Type resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false tinRequired: type: boolean description: Indicates if a tax id number is required. nullable: true default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/tax-id-types/{id}': get: operationId: getTaxIdType tags: - Tax Id Types description: >- The endpoint to retrieve a Tax Id Type resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false tinRequired: type: boolean description: Indicates if a tax id number is required. nullable: true default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceTaxIdType tags: - Tax Id Types description: The endpoint to update a Tax Identification Type resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Tax Identification Type resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false tinRequired: type: boolean description: Indicates if a tax id number is required. nullable: true default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteTaxIdType tags: - Tax Id Types description: The endpoint to delete a Tax Identification Type resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/entity-subtypes': get: operationId: listEntitySubtypes tags: - Entity Sub Types description: >- The endpoint to retrieve all of the Entity Sub Type resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: entitySubTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createEntitySubtype tags: - Entity Sub Types description: The endpoint to add a Entity Sub Type resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Entity Sub Type resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/entity-subtypes/{id}': get: operationId: getEntitySubtype tags: - Entity Sub Types description: >- The endpoint to retrieve a Entity Sub Type resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceEntitySubtype tags: - Entity Sub Types description: The endpoint to update a Entity Sub Type resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Entity Sub Type resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteEntitySubtype tags: - Entity Sub Types description: The endpoint to delete a Entity Sub Type resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/insider-roles': get: operationId: listInsiderRoles tags: - Insider Roles description: >- The endpoint to retrieve all of the Insider Role resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: taxIdTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createInsiderRole tags: - Insider Roles description: The endpoint to add an Insider Role resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Insider Role resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/insider-roles/{id}': get: operationId: getInsiderRole tags: - Insider Roles description: >- The endpoint to retrieve an Insider Role resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceInsiderRole tags: - Insider Roles description: The endpoint to update an Insider Role resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Insider Role resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteInsiderRole tags: - Insider Roles description: The endpoint to delete an Insider Role resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/genders': get: operationId: listGenders tags: - Genders description: >- The endpoint to retrieve all of the Gender resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: taxIdTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createGender tags: - Genders description: The endpoint to add a Gender resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Gender resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/genders/{id}': get: operationId: getGender tags: - Genders description: The endpoint to retrieve a Gender resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceGender tags: - Genders description: The endpoint to update a Gender resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Gender resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteGender tags: - Genders description: The endpoint to delete a Gender resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/address-labels': get: operationId: listAddressLabels tags: - Address Labels description: >- The endpoint to retrieve all of the Address Label resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: addressLabels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createAddressLabel tags: - Address Labels description: The endpoint to add an Address Label resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Address Label resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/address-labels/{id}': get: operationId: getAddressLabel tags: - Address Labels description: >- The endpoint to retrieve an Address Label resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceAddressLabel tags: - Address Labels description: The endpoint to update an Address Label resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Address Label resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteAddressLabel tags: - Address Labels description: The endpoint to delete an Address Label resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/income-levels': get: operationId: listIncomeLevels tags: - Income Levels description: >- The endpoint to retrieve all of the Income Level resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: incomeLevels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - sortOrder properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false sortOrder: type: integer description: Indicates the sort order of the resource. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createIncomeLevel tags: - Income Levels description: The endpoint to add an Income Level resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Income Level resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - sortOrder properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false sortOrder: type: integer description: Indicates the sort order of the resource. responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceIncomeLevels tags: - Income Levels description: The endpoint to replace the list of Income Level resources. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Income Level resource to be updated. content: application/json: schema: type: object properties: incomeLevels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name - sortOrder properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false sortOrder: type: integer description: Indicates the sort order of the resource. responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/income-levels/{id}': get: operationId: getIncomeLevel tags: - Income Levels description: >- The endpoint to retrieve an Income Level resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - sortOrder properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false sortOrder: type: integer description: Indicates the sort order of the resource. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceIncomeLevel tags: - Income Levels description: The endpoint to update an Income Level resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Income Level resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - sortOrder properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false sortOrder: type: integer description: Indicates the sort order of the resource. responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteIncomeLevel tags: - Income Levels description: The endpoint to delete an Income Level resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/pronouns': get: operationId: listPronouns tags: - Pronouns description: >- The endpoint to retrieve all of the Pronoun resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: pronouns: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createPronoun tags: - Pronouns description: The endpoint to add a Pronoun resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Pronoun resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/pronouns/{id}': get: operationId: getPronoun tags: - Pronouns description: The endpoint to retrieve a Pronoun resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replacePronoun tags: - Pronouns description: The endpoint to update a Pronoun resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Pronoun resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deletePronoun tags: - Pronouns description: The endpoint to delete a Pronoun resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/races': get: operationId: listRaces tags: - Races description: >- The endpoint to retrieve all of the Race resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: races: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createRace tags: - Races description: The endpoint to add a Race resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Race resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/races/{id}': get: operationId: getRace tags: - Races description: The endpoint to retrieve a Race resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceRace tags: - Races description: The endpoint to update a Race resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Race resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteRace tags: - Races description: The endpoint to delete a Race resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/identification-types': get: operationId: listIdentificationTypes tags: - Identification Types description: >- The endpoint to retrieve all of the Identification Type resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: identificationTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createIdentificationType tags: - Identification Types description: The endpoint to add a Identification Type resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Identification Type resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/identification-types/{id}': get: operationId: getIdentificationType tags: - Identification Types description: >- The endpoint to retrieve a Identification Type resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceIdentificationType tags: - Identification Types description: The endpoint to update a Identification Type resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Identification Type resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteIdentificationType tags: - Identification Types description: The endpoint to delete a Identification Type resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/ethnicities': get: operationId: listEthnicities tags: - Ethnicities description: >- The endpoint to retrieve all of the Ethnicity resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: ethnicities: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createEthnicity tags: - Ethnicities description: The endpoint to add an Ethnicity resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Ethnicity resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/ethnicities/{id}': get: operationId: getEthnicity tags: - Ethnicities description: The endpoint to retrieve an Ethnicity resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceEthnicity tags: - Ethnicities description: The endpoint to update an Ethnicity resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Ethnicity resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteEthnicity tags: - Ethnicities description: The endpoint to delete an Ethnicity resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/disabilities': get: operationId: listDisabilities tags: - Disabilities description: >- The endpoint to retrieve all of the Disability resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: disabilities: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createDisability tags: - Disabilities description: The endpoint to add a Disability resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Disability resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/disabilities/{id}': get: operationId: getDisability tags: - Disabilities description: The endpoint to retrieve a Disability resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceDisability tags: - Disabilities description: The endpoint to update a Disability resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Disability resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteDisability tags: - Disabilities description: The endpoint to delete a Disability resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/digital-contact-point-labels': get: operationId: listDigitalContactPointLabels tags: - Digital Contact Point Labels description: >- The endpoint to retrieve all of the Digital Contact Point Label resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: digitalContactPointLabels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createDigitalContactPointLabel tags: - Digital Contact Point Labels description: >- The endpoint to add an Digital Contact Point Label resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The DigitalContactPointLabel resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/digital-contact-point-labels/{id}': get: operationId: getDigitalContactPointLabel tags: - Digital Contact Point Labels description: >- The endpoint to retrieve an Digital Contact Point Label resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceDigitalContactPointLabel tags: - Digital Contact Point Labels description: The endpoint to update an Digital Contact Point Label resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Digital Contact Point Label resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteDigitalContactPointLabel tags: - Digital Contact Point Labels description: The endpoint to delete an Digital Contact Point Label resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/phone-labels': get: operationId: listPhoneLabels tags: - Phone Labels description: >- The endpoint to retrieve all of the Phone Label resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: phoneLabels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createPhoneLabel tags: - Phone Labels description: The endpoint to add an Phone Label resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Phone Label resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/phone-labels/{id}': get: operationId: getPhoneLabel tags: - Phone Labels description: >- The endpoint to retrieve a Phone Label resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replacePhoneLabel tags: - Phone Labels description: The endpoint to update a Phone Label resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Phone Label resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deletePhoneLabel tags: - Phone Labels description: The endpoint to delete a Phone Label resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/privacy-opt-out-types': get: operationId: listPrivacyOptOutTypes tags: - Privacy Opt Out Types description: >- The endpoint to retrieve all of the Privacy Opt Out Type resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: privacyOptOutTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: >- Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createPrivacyOptOutType tags: - Privacy Opt Out Types description: The endpoint to add a Privacy Opt Out Type resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Privacy Opt Out Type resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/privacy-opt-out-types/{id}': get: operationId: getPrivacyOptOutType tags: - Privacy Opt Out Types description: >- The endpoint to retrieve a Privacy Opt Out Type resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replacePrivacyOptOutType tags: - Privacy Opt Out Types description: The endpoint to update a Privacy Opt Out Type resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Privacy Opt Out Type resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deletePrivacyOptOutType tags: - Privacy Opt Out Types description: The endpoint to delete a Privacy Opt Out Type resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/entity-settings': get: operationId: getEntitySettings tags: - Entity Settings description: >- The endpoint to retrieve all of the Entity Settings allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: isEntitySubtypeMandatory: type: boolean description: >- Indicates whether the entity subtype resource is mandatory or not. nullable: true default: true isIdentificationMandatory: type: boolean description: >- Indicates whether the identification resource is mandatory or not. nullable: true default: true allowPrivacyOptOutAll: type: boolean description: >- Indicates whether the privacy opt out all option is provided. nullable: true default: true allowAffiliateOptOutAll: type: boolean description: >- Indicates whether the affiliate opt out all option is provided. nullable: true default: true defaultAddressLabelId: type: string format: uuid description: The default address label id. nullable: true defaultAffiliateOptOutExceptionReasonId: type: string format: uuid description: The default affiliate opt out exception reason id. nullable: true defaultDigitalContactPointLabelId: type: string format: uuid description: The default digital contact point label id. nullable: true defaultIncomeLevelId: type: string format: uuid description: The default income level id. nullable: true defaultPhoneLabelId: type: string format: uuid description: The default phone label id. nullable: true defaultInsiderRoleId: type: string format: uuid description: The default insider role id. nullable: true defaultLegalEntityExclusionReasonId: type: string format: uuid description: The default legal entity exclusion reason id. nullable: true defaultIndividualTaxIdTypeId: type: string format: uuid description: The default individual tax id type id. nullable: true defaultNonindividualTaxIdTypeId: type: string format: uuid description: The default nonindividual tax id type id. nullable: true defaultIndividualEntitySubtypeId: type: string format: uuid description: The default individual entity subtype id. nullable: true defaultNonindividualEntitySubtypeId: type: string format: uuid description: The default nonindividual entity subtype id. nullable: true w8TaxReportingAutomateWithholding: type: boolean description: >- Indicates if automatic withholding should occur on expired W8s. nullable: true default: true w8TaxReportingExpirationNoticeLeadDays: type: integer description: > Number of days before W8 expiration date to produce the W8 expiration notice. Value must be between 0 and 999. nullable: true default: 0 '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceEntitySettings tags: - Entity Settings description: The endpoint to update an Entity Settings resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Entity Settings resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: isEntitySubtypeMandatory: type: boolean description: >- Indicates whether the entity subtype resource is mandatory or not. nullable: true default: true isIdentificationMandatory: type: boolean description: >- Indicates whether the identification resource is mandatory or not. nullable: true default: true allowPrivacyOptOutAll: type: boolean description: >- Indicates whether the privacy opt out all option is provided. nullable: true default: true allowAffiliateOptOutAll: type: boolean description: >- Indicates whether the affiliate opt out all option is provided. nullable: true default: true defaultAddressLabelId: type: string format: uuid description: The default address label id. nullable: true defaultAffiliateOptOutExceptionReasonId: type: string format: uuid description: The default affiliate opt out exception reason id. nullable: true defaultDigitalContactPointLabelId: type: string format: uuid description: The default digital contact point label id. nullable: true defaultIncomeLevelId: type: string format: uuid description: The default income level id. nullable: true defaultPhoneLabelId: type: string format: uuid description: The default phone label id. nullable: true defaultInsiderRoleId: type: string format: uuid description: The default insider role id. nullable: true defaultLegalEntityExclusionReasonId: type: string format: uuid description: The default legal entity exclusion reason id. nullable: true defaultIndividualTaxIdTypeId: type: string format: uuid description: The default individual tax id type id. nullable: true defaultNonindividualTaxIdTypeId: type: string format: uuid description: The default nonindividual tax id type id. nullable: true defaultIndividualEntitySubtypeId: type: string format: uuid description: The default individual entity subtype id. nullable: true defaultNonindividualEntitySubtypeId: type: string format: uuid description: The default nonindividual entity subtype id. nullable: true w8TaxReportingAutomateWithholding: type: boolean description: >- Indicates if automatic withholding should occur on expired W8s. nullable: true default: true w8TaxReportingExpirationNoticeLeadDays: type: integer description: > Number of days before W8 expiration date to produce the W8 expiration notice. Value must be between 0 and 999. nullable: true default: 0 responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/phone-settings': get: operationId: getPhoneSettings tags: - Phone Settings description: >- The endpoint to retrieve all of the Phone Settings allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Successful get. content: application/json: schema: type: object properties: defaultCountryCallingCode: type: string description: >- Default country calling code value. Tha length of country calling code should not exceed 3. nullable: true default: '001' '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replacePhoneSettings tags: - Phone Settings description: The endpoint to update an Phone Settings resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Phone Settings resource to be updated. content: application/json: schema: type: object properties: defaultCountryCallingCode: type: string description: >- Default country calling code value. Tha length of country calling code should not exceed 3. nullable: true default: '001' responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/affiliate-opt-out-types': get: operationId: listAffiliateOptOutTypes tags: - Affiliate Opt Out Types description: >- The endpoint to retrieve all of the Affiliate Opt Out Type resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: affiliateOptOutTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: >- Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createAffiliateOptOutType tags: - Affiliate Opt Out Types description: >- The endpoint to add an Affiliate Opt Out Type resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Affiliate Opt Out Type resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/affiliate-opt-out-types/{id}': get: operationId: getAffiliateOptOutType tags: - Affiliate Opt Out Types description: >- The endpoint to retrieve an Affiliate Opt Out Type resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceAffiliateOptOutType tags: - Affiliate Opt Out Types description: The endpoint to update an Affiliate Opt Out Type resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Affiliate Opt Out Type resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteAffiliateOptOutType tags: - Affiliate Opt Out Types description: The endpoint to delete an Affiliate Opt Out Type resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/affiliate-opt-out-exception-reasons': get: operationId: listAffiliateOptOutExceptionReasons tags: - Affiliate Opt Out Exception Reasons description: >- The endpoint to retrieve all of the Affiliate Opt Out Exception Reason resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: affiliateOptOutExceptionReasons: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createAffiliateOptOutExceptionReason tags: - Affiliate Opt Out Exception Reasons description: >- The endpoint to add an Affiliate Opt Out Exception Reason resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Affiliate Opt Out Exception Reason resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/affiliate-opt-out-exception-reasons/{id}': get: operationId: getAffiliateOptOutExceptionReason tags: - Affiliate Opt Out Exception Reasons description: >- The endpoint to retrieve an Affiliate Opt Out Exception Reason resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceAffiliateOptOutExceptionReason tags: - Affiliate Opt Out Exception Reasons description: The endpoint to update an Affiliate Opt Out Exception Reason resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Affiliate Opt Out Exception Reason resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteAffiliateOptOutExceptionReason tags: - Affiliate Opt Out Exception Reasons description: The endpoint to delete an Affiliate Opt Out Exception Reason resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/legal-entity-exclusion-reasons': get: operationId: listLegalEntityExclusionReason tags: - Legal Entity Exclusion Reasons description: >- The endpoint to retrieve all of the Legal Entity Exclusion Reason resources allowed by an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: legalEntityExclusionReasons: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: operationId: createLegalEntityExclusionReason tags: - Legal Entity Exclusion Reasons description: >- The endpoint to add a Legal Entity Exclusion Reason resource for an Institution. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: The Legal Entity Exclusion Reason resource to be created. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '201': description: Successful create. content: application/json: schema: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/legal-entity-exclusion-reasons/{id}': get: operationId: getLegalEntityExclusionReason tags: - Legal Entity Exclusion Reasons description: >- The endpoint to retrieve a Legal Entity Exclusion Reason resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: replaceLegalEntityExclusionReason tags: - Legal Entity Exclusion Reasons description: The endpoint to update a Legal Entity Exclusion Reason resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid requestBody: description: The Legal Entity Exclusion Reason resource to be updated. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false responses: '204': description: No Content - Successful update. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteLegalEntityExclusionReason tags: - Legal Entity Exclusion Reasons description: The endpoint to delete a Legal Entity Exclusion Reason resource. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/chapter-exemptions': get: operationId: listChapterExemptions tags: - Chapter Exemptions description: >- The endpoint to retrieve all of the Chapter Exemption resources defined by the IRS. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: chapterExemptions: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/chapter-exemptions/{id}': get: operationId: getChapterExemption tags: - Chapter Exemptions description: >- The endpoint to retrieve a Chapter Exemption resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/chapter-statuses': get: operationId: listChapterStatuses tags: - Chapter Statuses description: >- The endpoint to retrieve all of the Chapter Status resources defined by the IRS. parameters: - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Successful get. content: application/json: schema: type: object properties: chapterStatuses: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/chapter-statuses/{id}': get: operationId: getChapterStatus tags: - Chapter Statuses description: >- The endpoint to retrieve a Chapter Status resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/w8-types': get: operationId: listW8types tags: - W8 Types description: >- The endpoint to retrieve all of the W8 Type resources defined by the IRS. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: W8Types: type: array items: allOf: - type: object properties: id: type: string description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/w8-types/{id}': get: operationId: getW8Type tags: - W8 Types description: The endpoint to retrieve a W8 Type resource by its unique identifier. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: id in: path description: Identifies the resource for which the message is intended. required: true schema: type: string format: uuid responses: '200': description: Successful get. content: application/json: schema: allOf: - type: object properties: id: type: string description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/settings': get: operationId: listSettings tags: - Settings description: The endpoint to retrieve all of the entity settings resources. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: includeInactive in: query description: Response will include inactive resources when set to true. schema: type: boolean default: false responses: '200': description: Successful get. content: application/json: schema: type: object properties: entitySettings: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: isEntitySubtypeMandatory: type: boolean description: >- Indicates whether the entity subtype resource is mandatory or not. nullable: true default: true isIdentificationMandatory: type: boolean description: >- Indicates whether the identification resource is mandatory or not. nullable: true default: true allowPrivacyOptOutAll: type: boolean description: >- Indicates whether the privacy opt out all option is provided. nullable: true default: true allowAffiliateOptOutAll: type: boolean description: >- Indicates whether the affiliate opt out all option is provided. nullable: true default: true defaultAddressLabelId: type: string format: uuid description: The default address label id. nullable: true defaultAffiliateOptOutExceptionReasonId: type: string format: uuid description: The default affiliate opt out exception reason id. nullable: true defaultDigitalContactPointLabelId: type: string format: uuid description: The default digital contact point label id. nullable: true defaultIncomeLevelId: type: string format: uuid description: The default income level id. nullable: true defaultPhoneLabelId: type: string format: uuid description: The default phone label id. nullable: true defaultInsiderRoleId: type: string format: uuid description: The default insider role id. nullable: true defaultLegalEntityExclusionReasonId: type: string format: uuid description: The default legal entity exclusion reason id. nullable: true defaultIndividualTaxIdTypeId: type: string format: uuid description: The default individual tax id type id. nullable: true defaultNonindividualTaxIdTypeId: type: string format: uuid description: The default nonindividual tax id type id. nullable: true defaultIndividualEntitySubtypeId: type: string format: uuid description: The default individual entity subtype id. nullable: true defaultNonindividualEntitySubtypeId: type: string format: uuid description: The default nonindividual entity subtype id. nullable: true w8TaxReportingAutomateWithholding: type: boolean description: >- Indicates if automatic withholding should occur on expired W8s. nullable: true default: true w8TaxReportingExpirationNoticeLeadDays: type: integer description: > Number of days before W8 expiration date to produce the W8 expiration notice. Value must be between 0 and 999. nullable: true default: 0 addressLabels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false affiliateOptOutExceptionReasons: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false affiliateOptOutTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: >- Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false chapterExemptions: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. chapterStatuses: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. countryCodes: type: array items: type: object properties: numeric: type: string description: >- The unique ISO three numeric character code for the Country. minLength: 3 maxLength: 3 nullable: false alpha2: type: string description: >- The unique ISO two Alpha character code for the Country. minLength: 2 maxLength: 2 nullable: false alpha3: type: string description: >- The unique ISO three Alpha character code for the Country. Must contain 3 alpha characters. minLength: 3 maxLength: 3 nullable: false name: type: string description: The full name of the Country. maxLength: 255 nullable: false digitalContactPointLabels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false disabilities: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false entitySubtypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ethnicities: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false genders: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false identificationTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false incomeLevels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - sortOrder properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false sortOrder: type: integer description: Indicates the sort order of the resource. insiderRoles: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false legalEntityExclusionReasons: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneLabels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneSettings: type: object properties: defaultCountryCallingCode: type: string description: >- Default country calling code value. Tha length of country calling code should not exceed 3. nullable: true default: '001' privacyOptOutTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: >- Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false pronouns: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false races: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false stateCodes: type: array items: type: object properties: alpha2: type: string description: >- The unique ISO two Alpha character code for the State. minLength: 2 maxLength: 2 nullable: false fips: type: string description: The unique FIPS code for the State. maxLength: 2 nullable: false name: type: string description: The full name of the State. maxLength: 255 nullable: false taxIdTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false tinRequired: type: boolean description: Indicates if a tax id number is required. nullable: true default: false w8Types: type: array items: allOf: - type: object properties: id: type: string description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/country-codes': get: operationId: listCountryCodes tags: - Country Codes description: The method to retrieve all of the Country Code resources. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Successful get. content: application/json: schema: type: object properties: countryCodes: type: array items: type: object properties: numeric: type: string description: >- The unique ISO three numeric character code for the Country. minLength: 3 maxLength: 3 nullable: false alpha2: type: string description: >- The unique ISO two Alpha character code for the Country. minLength: 2 maxLength: 2 nullable: false alpha3: type: string description: >- The unique ISO three Alpha character code for the Country. Must contain 3 alpha characters. minLength: 3 maxLength: 3 nullable: false name: type: string description: The full name of the Country. maxLength: 255 nullable: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/country-codes/{key}': get: operationId: getCountryCode tags: - Country Codes description: The method to retrieve an individual Country Code resources. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: key in: path description: Identifies the value of the field to be filtered by. required: true schema: type: string - name: keyField in: query description: Identifies the field to filter the result by. schema: type: string default: alpha2 responses: '200': description: Successful get. content: application/json: schema: type: object properties: numeric: type: string description: >- The unique ISO three numeric character code for the Country. minLength: 3 maxLength: 3 nullable: false alpha2: type: string description: The unique ISO two Alpha character code for the Country. minLength: 2 maxLength: 2 nullable: false alpha3: type: string description: >- The unique ISO three Alpha character code for the Country. Must contain 3 alpha characters. minLength: 3 maxLength: 3 nullable: false name: type: string description: The full name of the Country. maxLength: 255 nullable: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/county-codes': get: operationId: listCountyCodes tags: - County Codes description: The method to retrieve all of the County Code resources. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Successful get. content: application/json: schema: type: object properties: countyCodes: type: array items: type: object properties: fips: type: string description: The unique FIPS code for the County. maxLength: 5 nullable: false name: type: string description: The name of the County. maxLength: 255 nullable: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/county-codes/{fips}': get: operationId: getCountyCode tags: - County Codes description: The method to retrieve an individual County Code resources. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: fips in: path description: Identifies the FIPS code to be returned. required: true schema: type: string responses: '200': description: Successful get. content: application/json: schema: type: object properties: fips: type: string description: The unique FIPS code for the County. maxLength: 5 nullable: false name: type: string description: The name of the County. maxLength: 255 nullable: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/state-codes': get: operationId: listStateCodes tags: - State Codes description: The method to retrieve all of the State Code resources. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Successful get. content: application/json: schema: type: object properties: stateCodes: type: array items: type: object properties: alpha2: type: string description: >- The unique ISO two Alpha character code for the State. minLength: 2 maxLength: 2 nullable: false fips: type: string description: The unique FIPS code for the State. maxLength: 2 nullable: false name: type: string description: The full name of the State. maxLength: 255 nullable: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/entities/state-codes/{key}': get: operationId: getStateCode tags: - State Codes description: The method to retrieve an individual State Code resources. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: key in: path description: Identifies the value of the field to be filtered by. required: true schema: type: string - name: keyField in: query description: Identifies the field to filter the result by. schema: type: string default: alpha2 responses: '200': description: Successful get. content: application/json: schema: type: object properties: alpha2: type: string description: The unique ISO two Alpha character code for the State. minLength: 2 maxLength: 2 nullable: false fips: type: string description: The unique FIPS code for the State. maxLength: 2 nullable: false name: type: string description: The full name of the State. maxLength: 255 nullable: false '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/aggregate-search/entities': post: operationId: searchAggregateRelationshipByEntitySearch tags: - Aggregate Relationship Search description: >- This endpoint allows you to search for relationships, entities, accounts, and transactions in a single call by an Entity Search Request. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - schema: type: string default: '0' name: offset in: query required: false description: >- When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. example: '?offset=50' - schema: type: string default: '25' name: count in: query required: false description: >- The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: '?count=100' - name: NoBalance in: query description: > If set to true, the response will not include the balance/transaction information. Example: `.../resource?NoBalance=true` required: false schema: type: string default: 'false' requestBody: description: >- An aggregate search request by searching for the entity first. Name or TaxIdNumber is required required: true content: application/json: schema: type: object properties: name: type: string description: >- any part of a name, (first name, last name, preferred name). You can put spaces between names to denote another part of a name minLength: 3 maxLength: 255 taxIdNumber: type: string description: The tax id number or ssn of the entity nullable: true responses: '200': description: Successful Search content: application/json: schema: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: > The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - >- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: >- The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: >- This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: >- This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: >- This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: >- This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: >- This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: >- The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: >- The unique identifier given to an account. nullable: false linkType: type: string description: >- The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: >- The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/aggregate-search/entities/{EntityId}': get: operationId: getAggregateRelationship tags: - Aggregate Relationship Search description: >- This endpoint allows you to search for relationships, entities, accounts, and transactions in a single call by an EntityId. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: EntityId in: path description: A unique identifier of the Entity required: true schema: type: string format: uuid - schema: type: string default: '0' name: offset in: query required: false description: >- When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. example: '?offset=50' - schema: type: string default: '25' name: count in: query required: false description: >- The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: '?count=100' - name: NoBalance in: query description: > If set to true, the response will not include the balance/transaction information. Example: `.../resource?NoBalance=true` required: false schema: type: string default: 'false' responses: '200': description: Successful Search content: application/json: schema: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: > The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - >- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: >- The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: >- This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: >- This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: >- This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: >- This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: >- This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: >- The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: >- The unique identifier given to an account. nullable: false linkType: type: string description: >- The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: >- The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/aggregate-search/relationships': post: operationId: searchAggregateRelationshipByRelationshipSearch tags: - Aggregate Relationship Search description: >- This endpoint allows you to search for relationships, entities, accounts, and transactions in a single call by a Relationship Search Request. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: NoBalance in: query description: > If set to true, the response will not include the balance/transaction information. Example: `.../resource?NoBalance=true` required: false schema: type: string default: 'false' requestBody: description: >- An aggregate search request by searching for the relationship first. AssetId (Account Id) and Asset Type are required required: true content: application/json: schema: type: object properties: assetId: type: string format: uuid description: > The unique identifier given to an account. This value must be an existing account identifier. This is the Account Id not the account number nullable: true assetType: type: string description: >- The Asset Type. Currently the only accepted values is Accounts nullable: true example: Accounts enum: - Accounts responses: '200': description: Successful Search content: application/json: schema: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: > The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - >- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: >- The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: >- This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: >- This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: >- This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: >- This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: >- This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: >- The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: >- The unique identifier given to an account. nullable: false linkType: type: string description: >- The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: >- The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/aggregate-search/accounts': post: operationId: searchAggregateRelationshipByAccountSearch tags: - Aggregate Relationship Search description: >- This endpoint allows you to search for relationships, entities, accounts, and transactions in a single call by an Account Search Request. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: NoBalance in: query description: > If set to true, the response will not include the balance/transaction information. Example: `.../resource?NoBalance=true` required: false schema: type: string default: 'false' requestBody: description: >- An aggregate search request by searching for the Account first. Account Number (Human Readable) and Account Type are required required: true content: application/json: schema: type: object properties: accountNumber: type: string description: The human readable account number. nullable: true accountType: type: string description: The account type. lower case only nullable: true example: checking enum: - checking - savings responses: '200': description: Successful Search content: application/json: schema: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: > The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - >- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: >- The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: >- This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: >- This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: >- This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: >- This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: >- This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: >- The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: >- The unique identifier given to an account. nullable: false linkType: type: string description: >- The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: >- The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/aggregate-search/accounts/list': post: operationId: searchAggregateRelationshipByAccountListSearch tags: - Aggregate Relationship Search description: >- This endpoint allows you to search for relationships and entities by Multiple Account id in a single call by an Account Search Request. All returned entities are IRSReportable Entities parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: A list of accountIds required: true content: application/json: schema: type: object properties: accountIds: type: array description: An array of strings items: type: string format: uuid description: AccountId nullable: false nullable: false responses: '200': description: >- Successful Search, IRS reportable entities, relationships, and balance content: application/json: schema: type: object properties: accountsResponse: type: array items: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: > The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: >- This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: >- The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: >- An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: >- The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: >- Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: > The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - >- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: >- The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: >- This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: >- This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: >- This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: >- This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: >- This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: >- This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: >- This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: >- The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: >- The unique identifier given to an account. nullable: false linkType: type: string description: >- The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: >- The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: >- The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer '207': description: >- Partial Success of finding accounts. Accounts not found will read with an empty Entity and no relationships, with the accountNumber Account Not Found. Other accounts that are found will have the schema as 200 OK content: application/json: schema: type: object properties: accountsResponse: type: array items: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: > The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: >- This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: >- The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: >- An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: >- The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: >- Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: > The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - >- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: >- The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: >- This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: >- This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: >- This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: >- This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: >- This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: >- This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: >- This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: >- The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: >- The unique identifier given to an account. nullable: false linkType: type: string description: >- The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: >- The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: >- The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/aggregate-search/cards/list': post: operationId: AggregateSearchByCardList tags: - Aggregate Relationship Search description: >- This endpoint allows you to search for relationships and entities by Multiple Card ids in a single call by an Card Search Request. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: A list of card ids required: true content: application/json: schema: type: object properties: cardIds: type: array description: An array of strings items: type: string description: The unique token given to a card. nullable: false nullable: false responses: '200': description: 'Successful Search, entities, relationships, and cards' content: application/json: schema: type: object properties: accountsResponse: type: array items: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: > The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: >- This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: >- The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: >- An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: >- The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: >- Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: > The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - >- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: >- The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: >- This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: >- This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: >- This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: >- This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: >- This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: >- This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: >- This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: >- The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: >- The unique identifier given to an account. nullable: false linkType: type: string description: >- The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: >- The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: >- The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer '207': description: >- Partial Success of finding cards. Cards not found will read with an empty Entity and no relationships, with the MaskCard Not Found. Other cards that are found will have the schema as 200 OK content: application/json: schema: type: object properties: accountsResponse: type: array items: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: > The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: >- This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: >- The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: >- An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: >- The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: >- Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: > The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - >- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: >- The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: >- This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: >- This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: >- This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: >- This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: >- This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: >- This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: >- This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: >- The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: >- The unique identifier given to an account. nullable: false linkType: type: string description: >- The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: >- The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: >- The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{enterpriseUserId}/aggregate-search/entities': post: operationId: searchAggregateRelationshipByEntitySearch1 tags: - Aggregate Relationship Search description: >- This endpoint allows you to search for relationships, entities, accounts, and transactions in a single call by an Entity Search Request. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - schema: type: string default: '0' name: offset in: query required: false description: >- When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. example: '?offset=50' - schema: type: string default: '25' name: count in: query required: false description: >- The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: '?count=100' - name: NoBalance in: query description: > If set to true, the response will not include the balance/transaction information. Example: `.../resource?NoBalance=true` required: false schema: type: string default: 'false' requestBody: description: >- An aggregate search request by searching for the entity first. Name or TaxIdNumber is required required: true content: application/json: schema: type: object properties: name: type: string description: >- any part of a name, (first name, last name, preferred name). You can put spaces between names to denote another part of a name minLength: 3 maxLength: 255 taxIdNumber: type: string description: The tax id number or ssn of the entity nullable: true responses: '200': description: Successful Search content: application/json: schema: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: > The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - >- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: >- The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: >- This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: >- This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: >- This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: >- This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: >- This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: >- The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: >- The unique identifier given to an account. nullable: false linkType: type: string description: >- The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: >- The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{enterpriseUserId}/aggregate-search/entities/{EntityId}': get: operationId: getAggregateRelationship1 tags: - Aggregate Relationship Search description: >- This endpoint allows you to search for relationships, entities, accounts, and transactions in a single call by an EntityId. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: EntityId in: path description: A unique identifier of the Entity required: true schema: type: string format: uuid - schema: type: string default: '0' name: offset in: query required: false description: >- When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. example: '?offset=50' - schema: type: string default: '25' name: count in: query required: false description: >- The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: '?count=100' - name: NoBalance in: query description: > If set to true, the response will not include the balance/transaction information. Example: `.../resource?NoBalance=true` required: false schema: type: string default: 'false' responses: '200': description: Successful Search content: application/json: schema: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: > The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - >- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: >- The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: >- This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: >- This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: >- This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: >- This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: >- This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: >- The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: >- The unique identifier given to an account. nullable: false linkType: type: string description: >- The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: >- The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{enterpriseUserId}/aggregate-search/relationships': post: operationId: searchAggregateRelationshipByRelationshipSearch1 tags: - Aggregate Relationship Search description: >- This endpoint allows you to search for relationships, entities, accounts, and transactions in a single call by a Relationship Search Request. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: NoBalance in: query description: > If set to true, the response will not include the balance/transaction information. Example: `.../resource?NoBalance=true` required: false schema: type: string default: 'false' requestBody: description: >- An aggregate search request by searching for the relationship first. AssetId (Account Id) and Asset Type are required required: true content: application/json: schema: type: object properties: assetId: type: string format: uuid description: > The unique identifier given to an account. This value must be an existing account identifier. This is the Account Id not the account number nullable: true assetType: type: string description: >- The Asset Type. Currently the only accepted values is Accounts nullable: true example: Accounts enum: - Accounts responses: '200': description: Successful Search content: application/json: schema: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: > The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - >- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: >- The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: >- This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: >- This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: >- This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: >- This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: >- This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: >- The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: >- The unique identifier given to an account. nullable: false linkType: type: string description: >- The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: >- The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{enterpriseUserId}/aggregate-search/accounts': post: operationId: searchAggregateRelationshipByAccountSearch1 tags: - Aggregate Relationship Search description: >- This endpoint allows you to search for relationships, entities, accounts, and transactions in a single call by an Account Search Request. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: NoBalance in: query description: > If set to true, the response will not include the balance/transaction information. Example: `.../resource?NoBalance=true` required: false schema: type: string default: 'false' requestBody: description: >- An aggregate search request by searching for the Account first. Account Number (Human Readable) and Account Type are required required: true content: application/json: schema: type: object properties: accountNumber: type: string description: The human readable account number. nullable: true accountType: type: string description: The account type. lower case only nullable: true example: checking enum: - checking - savings responses: '200': description: Successful Search content: application/json: schema: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: > The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - >- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: >- The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: >- This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: >- This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: >- This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: >- This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: >- This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: >- The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: >- The unique identifier given to an account. nullable: false linkType: type: string description: >- The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: >- The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{enterpriseUserId}/aggregate-search/accounts/list': post: operationId: searchAggregateRelationshipByAccountListSearch1 tags: - Aggregate Relationship Search description: >- This endpoint allows you to search for relationships and entities by Multiple Account id in a single call by an Account Search Request. All returned entities are IRSReportable Entities parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: A list of accountIds required: true content: application/json: schema: type: object properties: accountIds: type: array description: An array of strings items: type: string format: uuid description: AccountId nullable: false nullable: false responses: '200': description: >- Successful Search, IRS reportable entities, relationships, and balance content: application/json: schema: type: object properties: accountsResponse: type: array items: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: > The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: >- This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: >- The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: >- An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: >- The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: >- Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: > The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - >- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: >- The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: >- This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: >- This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: >- This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: >- This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: >- This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: >- This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: >- This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: >- The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: >- The unique identifier given to an account. nullable: false linkType: type: string description: >- The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: >- The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: >- The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer '207': description: >- Partial Success of finding accounts. Accounts not found will read with an empty Entity and no relationships, with the accountNumber Account Not Found. Other accounts that are found will have the schema as 200 OK content: application/json: schema: type: object properties: accountsResponse: type: array items: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: > The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: >- This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: >- The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: >- An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: >- The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: >- Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: > The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - >- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: >- The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: >- This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: >- This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: >- This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: >- This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: >- This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: >- This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: >- This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: >- The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: >- The unique identifier given to an account. nullable: false linkType: type: string description: >- The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: >- The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: >- The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/enterprise/{enterpriseUserId}/aggregate-search/cards/list': post: operationId: AggregateSearchByCardList1 tags: - Aggregate Relationship Search description: >- This endpoint allows you to search for relationships and entities by Multiple Card ids in a single call by an Card Search Request. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: description: A list of card ids required: true content: application/json: schema: type: object properties: cardIds: type: array description: An array of strings items: type: string description: The unique token given to a card. nullable: false nullable: false responses: '200': description: 'Successful Search, entities, relationships, and cards' content: application/json: schema: type: object properties: accountsResponse: type: array items: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: > The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: >- This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: >- The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: >- An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: >- The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: >- Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: > The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - >- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: >- The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: >- This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: >- This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: >- This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: >- This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: >- This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: >- This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: >- This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: >- The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: >- The unique identifier given to an account. nullable: false linkType: type: string description: >- The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: >- The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: >- The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer '207': description: >- Partial Success of finding cards. Cards not found will read with an empty Entity and no relationships, with the MaskCard Not Found. Other cards that are found will have the schema as 200 OK content: application/json: schema: type: object properties: accountsResponse: type: array items: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: > Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: > The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: >- This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: >- The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: >- An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: >- The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: >- The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: >- A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: >- Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: > The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - >- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: >- The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: >- This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: >- This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: >- This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: >- This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: >- This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: >- This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: >- This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: >- This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: >- The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: >- The unique identifier given to an account. nullable: false linkType: type: string description: >- The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: >- The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: >- The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: >- The total number of records requested for pagination type: integer '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error '/a/api/entity-svcs/v1/{InstitutionUniversalId}/profile-images/{linkId}': post: operationId: uploadProfileImage tags: - Profile Image Service description: > This endpoint allows you to upload a profile image for an service key and linkId. The linkId is a unique identifier specific serviceKey, such as entity-svcs and a entityId as the linkId. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: linkId in: path description: A unique identifier for the specific serviceKey. required: true schema: type: string format: uuid requestBody: description: A profile image that will be uploaded and stored for later retrieval. required: true content: multipart/form-data: schema: type: object properties: file: type: string format: binary description: > The file to upload. The file must be a valid image format (PNG, JPEG, GIF). The maximum file size is .5MB. The image file must have a key called 'image'. responses: '201': description: Content created '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error get: operationId: getProfileImage tags: - Profile Image Service description: > This endpoint allows you to retrieve a profile image by the service key and LinkId. The linkId is a unique identifier specific serviceKey, such as entity-svcs and a entityId as the linkId. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: linkId in: path description: A unique identifier for the specific serviceKey. required: true schema: type: string format: uuid responses: '200': description: >- Successful retrieval of profile image based on the mime type of the image. content: multipart/form-data: schema: type: object properties: file: type: string format: binary description: > The file to upload. The file must be a valid image format (PNG, JPEG, GIF). The maximum file size is .5MB. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: putProfileImage tags: - Profile Image Service description: >- This endpoint allows you to update the profile image and record for serviceKey and an unique linkId. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: linkId in: path description: A unique identifier for the specific serviceKey. required: true schema: type: string format: uuid requestBody: description: A profile image that will replace the previous image stored. required: true content: image/png: schema: type: string format: binary image/jpeg: schema: type: string format: binary image/gif: schema: type: string format: binary responses: '204': description: No content - Successful update '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: deleteProfileImage tags: - Profile Image Service description: >- This endpoint allows you to delete a profile image and the record for the image by service key and unique linkId. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: linkId in: path description: A unique identifier for the specific serviceKey. required: true schema: type: string format: uuid responses: '204': description: No content - Successful delete '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error head: operationId: headProfileImage tags: - Profile Image Service description: > This endpoint allows you to retrieve the headers of a profile image by the service key and LinkId. The linkId is a unique identifier specific serviceKey, such as entity-svcs and a entityId as the linkId. parameters: - name: InstitutionUniversalId in: path description: >- A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: linkId in: path description: A unique identifier for the specific serviceKey. required: true schema: type: string format: uuid responses: '200': description: > Successful retrieval of header information for profile image based on the mime type of the image, and the size of the image. '400': description: >- The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: >- The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: >- An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: >- A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: >- An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: > Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error components: schemas: AbilitiesResponse: type: object required: - addEntities - addEntityRelationships - addEntitySettings - addProfileImages - deleteEntities - deleteEntityRelationships - deleteEntitySettings - deleteProfileImages - editEntities - editEntitlements - editEntityRelationships - editEntitySettings - editProfileImages - editTaxIDNumbers - searchEntities - searchEntityRelationships - viewEntities - viewEntitlements - viewEntityRelationships - viewEntityReports - viewEntitySettings - viewProfileImages - viewTaxIDNumbers properties: addEntities: type: boolean nullable: false default: false addEntityRelationships: type: boolean nullable: false default: false addEntitySettings: type: boolean nullable: false default: false addProfileImages: type: boolean nullable: false default: false deleteEntities: type: boolean nullable: false default: false deleteEntityRelationships: type: boolean nullable: false default: false deleteEntitySettings: type: boolean nullable: false default: false deleteProfileImages: type: boolean nullable: false default: false editEntities: type: boolean nullable: false default: false editEntitlements: type: boolean nullable: false default: false editEntityRelationships: type: boolean nullable: false default: false editEntitySettings: type: boolean nullable: false default: false editProfileImages: type: boolean nullable: false default: false editTaxIDNumbers: type: boolean nullable: false default: false searchEntities: type: boolean nullable: false default: false searchEntityRelationships: type: boolean nullable: false default: false viewEntities: type: boolean nullable: false default: false viewEntitlements: type: boolean nullable: false default: false viewEntityRelationships: type: boolean nullable: false default: false viewEntityReports: type: boolean nullable: false default: false viewEntitySettings: type: boolean nullable: false default: false viewProfileImages: type: boolean nullable: false default: false viewTaxIDNumbers: type: boolean nullable: false default: false CreateAddressRequest: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array minItems: 1 description: | The individual lines of the address. At least one line is required. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. For US addresses, it will be validated against a valid ISO 3166-2 code. For non-US addresses, it will not be validated. nullable: true maxLength: 63 postalCode: type: string description: | The postal code linked to the address. It should be an alphanumeric value. nullable: false maxLength: 11 county: type: string description: > The County for the address. Valid for US addresses only. If the state value is provided, this attribute value must be valid for the state as per the state's FIPS code. nullable: true maxLength: 255 country: type: string description: > The ISO Alpha-2 country code. Defaults to 'US' if not provided. It will be validated for existence against the `CountryCode` settings if the value is not the default "US". The value will be capitalized. nullable: true default: US maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: | The time zone in which the address is located. Alpha Only characters allowed. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 isMailing: type: boolean description: | Indicates this as a mailing address. Only one address can be set as a mailing address. nullable: true default: false isTax: type: boolean description: | Indicates this as a tax address. Only one address can be set as a tax address. nullable: true default: false seasonalStartDate: type: string format: date description: This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: This attribute defines the end date for Seasonal Addresses. addressLabel: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false CreateAddressResponse: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true GetAddressResponse: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false GetStructuredAddressResponse: type: object required: - details properties: adrTp: type: string description: The type of address (structured or hybrid) nullable: true bldgNm: type: string description: The name of the building nullable: true bldgNb: type: string description: The number of the building nullable: true ctrySubDvsn: type: string description: The country subdivision nullable: true ctry: type: string description: The country nullable: true dept: type: string description: The department nullable: true dstrctNm: type: string description: The district name nullable: true flr: type: string description: The floor nullable: true pstBx: type: string description: The postbox nullable: true pstCd: type: string description: The postcode nullable: true room: type: string description: The room nullable: true strtNm: type: string description: The street name nullable: true subDept: type: string description: The sub department nullable: true twnLctnNm: type: string description: The town location name nullable: true twnNm: type: string description: The town name nullable: true ListAddressResponse: type: object properties: addresses: type: array items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false ReplaceAddressRequest: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array minItems: 1 description: | The individual lines of the address. At least one line is required. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. For US addresses, it will be validated against a valid ISO 3166-2 code. For non-US addresses, it will not be validated. nullable: true maxLength: 63 postalCode: type: string description: | The postal code linked to the address. It should be an alphanumeric value. nullable: false maxLength: 11 county: type: string description: > The County for the address. Valid for US addresses only. If the state value is provided, this attribute value must be valid for the state as per the state's FIPS code. nullable: true maxLength: 255 country: type: string description: > The ISO Alpha-2 country code. Defaults to 'US' if not provided. It will be validated for existence against the `CountryCode` settings if the value is not the default "US". The value will be capitalized. nullable: true default: US maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: | The time zone in which the address is located. Alpha Only characters allowed. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 isMailing: type: boolean description: | Indicates this as a mailing address. Only one address can be set as a mailing address. nullable: true default: false isTax: type: boolean description: | Indicates this as a tax address. Only one address can be set as a tax address. nullable: true default: false seasonalStartDate: type: string format: date description: This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: This attribute defines the end date for Seasonal Addresses. addressLabel: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false GetAffiliateOptOutResponse: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. exceptionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false exceptionDate: type: string format: date description: | The date when the Opt Out Exception takes effect. Date must be current date or a future date. nullable: true revokeDate: type: string format: date description: | The date when the Opt Out is to be revoked. Date must be a current date or a future date. nullable: true - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false ListAffiliateOptOutResponse: type: object properties: AffiliateOptOuts: type: array items: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. exceptionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false exceptionDate: type: string format: date description: | The date when the Opt Out Exception takes effect. Date must be current date or a future date. nullable: true revokeDate: type: string format: date description: | The date when the Opt Out is to be revoked. Date must be a current date or a future date. nullable: true - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false ReplaceAffiliateOptOutRequest: type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. exceptionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false exceptionDate: type: string format: date description: | The date when the Opt Out Exception takes effect. Date must be current date or a future date. nullable: true revokeDate: type: string format: date description: | The date when the Opt Out is to be revoked. Date must be a current date or a future date. nullable: true ResourceIdentifier: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false CreateDigitalContactPointRequest: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: The Id must be a valid Digital Contact Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false CreateDigitalContactPointResponse: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true GetDigitalContactPointResponse: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false ListDigitalContactPointResponse: type: object properties: digitalContactPoints: type: array items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false ReplaceDigitalContactPointRequest: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: The Id must be a valid Digital Contact Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false CreateEmploymentRequest: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 CreateEmploymentResponse: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true GetEmploymentResponse: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 ListEmploymentsResponse: type: object properties: employments: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: >- This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 ReplaceEmploymentRequest: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 GetEntitlementResponse: type: object properties: viewVip: type: boolean nullable: false default: false editVip: type: boolean nullable: false default: false viewInsiderRoles: type: array items: type: string format: uuid default: [] editInsiderRoles: type: array items: type: string format: uuid default: [] viewEntitiesAllowed: type: array items: type: string format: uuid default: [] editEntitiesAllowed: type: array items: type: string format: uuid default: [] viewEntitiesDenied: type: array items: type: string format: uuid default: [] editEntitiesDenied: type: array items: type: string format: uuid default: [] ReplaceEntitlementRequest: type: object properties: viewVip: type: boolean nullable: false default: false editVip: type: boolean nullable: false default: false viewInsiderRoles: type: array items: type: string format: uuid default: [] editInsiderRoles: type: array items: type: string format: uuid default: [] viewEntitiesAllowed: type: array items: type: string format: uuid default: [] editEntitiesAllowed: type: array items: type: string format: uuid default: [] viewEntitiesDenied: type: array items: type: string format: uuid default: [] editEntitiesDenied: type: array items: type: string format: uuid default: [] CreateEntityRequest: required: - addresses allOf: - type: object required: - entityType - taxIdType - entitySubtypeId - lastName - taxInformation properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityType: type: string description: | This attribute identifies the entity type. nullable: false enum: - Individual - Nonindividual entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: > If `IsEntitySubtypeMandatory` of `EntitySettings` is true, this property must have an Id value. The entity subtype must also be valid for the entity type based on `EntityTypesApplicable` settings. taxIdType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: > The tax id type must be valid for the entity type based on `EntityTypesApplicable` settings. taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: | Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 suffix: type: string description: >- This attribute defines the suffix that should follow the name of the entity. nullable: true maxLength: 31 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 foreignEntity: type: boolean description: >- This attribute designates whether the entity is a US person/Org or not. nullable: true default: false foreignTaxIdNumber: type: string description: > This attribute specifies the foreign Taxpayer Identification Number used for tax purposes in the country of residence. It will be utilized for 1042-S reporting. Must consist only of alphanumeric characters. maxLength: 25 nullable: true insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false startDate: type: string format: date description: > This attribute defines either the birth date of Individual or the start date of Nonindividual. Must be a current date or past date. nullable: true endDate: type: string format: date description: > This attribute defines either the deceased date of Individual or the end date of Nonindividual. Must be a current date or past date. nullable: true entityOfficerId: type: string format: uuid description: >- This attribute defines the primary officer Id associated to entity's account. nullable: true entityBranchAddressId: type: string format: uuid description: >- This attribute defines the branch Id associated to entity's account. nullable: true natureOfBusiness: type: string description: > This attribute defines the nature of business for the entity. It is a free-form text field that describes the primary business activity of the entity. nullable: true maxLength: 255 taxReturnDate: type: string format: date-time description: | This attribute defines the commercial tax return date. Must be a current date or past date. nullable: true ficoScore: type: string format: numeric only description: > This attribute is the FICO score of the entity. A numerical representation of the credit risk that helps FIs decide whether to approve loans or credit cards. minLength: 3 maxLength: 3 netWorth: description: > This attribute specifies the net worth currency value of the entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false gender: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. pronoun: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. race: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. ethnicity: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. disability: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. incomeLevel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. militaryInformation: allOf: - type: object description: The military information associated with this entity. properties: status: type: string description: >- This attribute indicates the military status of this entity. nullable: true enum: - Active Duty - Reserve - Inactive - Dependent activeDutyVerificationDate: type: string format: date description: This is the date active duty status was verified. nullable: true activeDutyStartDate: type: string format: date description: >- This date indicates the start date of active duty status. nullable: true activeDutySeparationDate: type: string format: date description: >- This date indicates the separation date from active duty status. nullable: true nullable: true - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true privacyOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Privacy Opt Out options. This value can only be set to true if the Institution's entity settings `AllowPrivacyOptOutAll` value is true. nullable: true default: false privacyActLastNoticeDate: type: string format: date-time description: > The timestamp of when the entity was last notified about the Privacy Act. Must be current date or a past date. nullable: true affiliateOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Affiliate Opt Out options. This value can only be set to true if the Institution's entity settings AllowAffiliateOptOutAll value is true. nullable: true default: false includeLegalEntity: type: boolean description: > This attribute represents the entity's inclusion to the FinCEN Customer Due Diligence (CDD) processes. If the value is set as false, the legal entity exclusion reason must be provided. nullable: true default: false legalEntityExclusionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- The attribute is required when `includeLegalEntity` is set to `false`. legalEntityId: type: string description: >- A unique alphanumeric identifier for legal entities participating in financial transactions. nullable: true maxLength: 20 taxInformation: type: object required: - irsReportable properties: taxIdCertificationStatus: type: string description: The status of the Tax Id certification. nullable: true enum: - IRS has generated B notice - Entity has certified the TIN provided - TIN certificate has been sent to entity taxIdCertificationDate: type: string format: date description: | The date the Tax Id was certified. Must be a current date or past date. nullable: true bNoticesSent: type: number format: int32 default: 0 description: | The number of B Notices sent to the Entity. Valid values: 0, 1, 2 nullable: true lastBNoticeDate: type: string format: date description: | The date the last B Notice was sent to the Entity. Must be a current date or past date. nullable: true irsReportable: type: string description: Indicates how the Entity will report to the IRS. nullable: false enum: - IRS Reportable - Foreign IRS Reportable - Non-IRS Reportable foreignEntityInformation: type: object properties: citizenshipCountry: type: object properties: alpha2: description: > Must be a valid ISO 3166-1 alpha-2 country code that should be present in `CountryCode` settings. type: string minLength: 2 maxLength: 2 nullable: false reportingChapter: type: string description: The Reporting Chapter used by the Entity. nullable: true enum: - Chapter 3 - Chapter 4 chapterExemption: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false chapterStatus: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false foreignCertificationInformation: type: object properties: w8Type: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false w8CertificationDate: type: string format: date description: | The date the W8 Form was certified. Must be a current date or past date. nullable: true w8ExpirationDate: type: string format: date description: | The date the W8 Form expires. Must be a future date. nullable: true giinId: type: string description: | The GIIN Id used by the Entity. nullable: true maxLength: 19 giinProvidedDate: type: string format: date description: | The date the GIIN was provided. Must be a current date or past date. nullable: true giinCertificationDate: type: string format: date description: | The date the GIIN was certified. Must be a current date or past date. nullable: true commercial: type: object properties: sicCode: type: string format: numeric only description: >- This attribute defines the Standard Industrial Classification (SIC) code used to classify the commercial entity by industry. minLength: 4 maxLength: 4 naicsCode: type: string format: numeric only description: >- This attribute defines the North American Industry Classification System (NAICS) code used to categorize the commercial entity based on primary economic activity. minLength: 4 maxLength: 4 grossAnnualRevenue: description: > This attribute specifies the gross annual revenue of a commercial entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false financialStatementDate: type: string format: date description: > This attribute defines the commercial financial statement date. Must be a current date or past date. nullable: true createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true - type: object properties: addresses: type: array description: > An array of addresses for the entity. To create an entity, at least one address is required in the addresses list, and one of the addresses must be a mailing address. More than one Tax Address or Mailing Address is not allowed. nullable: false items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array minItems: 1 description: | The individual lines of the address. At least one line is required. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. For US addresses, it will be validated against a valid ISO 3166-2 code. For non-US addresses, it will not be validated. nullable: true maxLength: 63 postalCode: type: string description: | The postal code linked to the address. It should be an alphanumeric value. nullable: false maxLength: 11 county: type: string description: > The County for the address. Valid for US addresses only. If the state value is provided, this attribute value must be valid for the state as per the state's FIPS code. nullable: true maxLength: 255 country: type: string description: > The ISO Alpha-2 country code. Defaults to 'US' if not provided. It will be validated for existence against the `CountryCode` settings if the value is not the default "US". The value will be capitalized. nullable: true default: US maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: | The time zone in which the address is located. Alpha Only characters allowed. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 isMailing: type: boolean description: | Indicates this as a mailing address. Only one address can be set as a mailing address. nullable: true default: false isTax: type: boolean description: | Indicates this as a tax address. Only one address can be set as a tax address. nullable: true default: false seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false phoneNumbers: type: array description: An array of phone numbers for the entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: > Internal phone extension designation for a multi-line phone number. Numeric only. nullable: true maxLength: 10 countryCallingCode: type: string description: | International country code with omitted prefix. Numeric only. nullable: true label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: The Id must be a valid Phone Number Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false isPreferredContactText: type: boolean description: > Indicates the Phone Number is the preferred method for text communication to be used for the Entity. This property is only available when creating an Entity. Only one Phone Number can be preferred text. isPreferredContactVoice: type: boolean description: > Indicates the Phone Number is the preferred method for voice communication to be used for the Entity. This property is only available when creating an Entity. Only one Phone Number can be preferred voice. digitalContactPoints: type: array description: An array of digital contact points for the entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: The Id must be a valid Digital Contact Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false isPreferredContactEmail: type: boolean description: > Indicates the Digital Contact Point is the preferred email address to be used for the Entity. This property is only available when creating an Entity. The Digital Contact Point Type must be "Email" and only one email address can be preferred. identifications: type: array description: > An array of Identification related information used to verify an entity's identity. Duplicate values are not allowed in the list. It must not be empty when `IsIdentificationMandatory` of `EntitySettings` is true. nullable: true items: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: required: - id description: | The Id must be a valid Identification Type Id. allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true privacyOptOuts: type: array description: | An array of Privacy Opt Out options. Duplicate values are not allowed in the list. nullable: true items: type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the Opt Out Type. value: description: > If the value is null, it will be set with the default value of `PrivacyOptOutType` settings. If the value is true and `PrivacyOptOutType.NoOptOut` settings is true, it will return an error indicating the `Opt out type` cannot be opted out of. type: boolean affiliateOptOuts: type: array description: | An array of Affiliate Opt Out options. Duplicate values are not allowed in the list. nullable: true items: type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the Opt Out Type. value: description: > If the value is null, it will be set with the default value of `AffiliateOptOutType` settings. If the value is true and `AffiliateOptOutType.NoOptOut` settings is true, it will return an error indicating the `Opt out type` cannot be opted out of. type: boolean exceptionReason: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false exceptionDate: type: string format: date description: | The date when the Opt Out Exception takes effect. Date must be current date or a future date. nullable: true revokeDate: type: string format: date description: | The date when the Opt Out is to be revoked. Date must be a current date or a future date. nullable: true employments: type: array description: An array of Employments for the entity. nullable: true items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: >- This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: >- This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 CreateEntityResponse: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true GetEntityResponse: type: object required: - entityType - taxIdType - entitySubtypeId - lastName - taxInformation properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityType: type: string description: | This attribute identifies the entity type. nullable: false enum: - Individual - Nonindividual entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false tinRequired: type: boolean description: Indicates if a tax id number is required. nullable: true default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: | This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: | Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 suffix: type: string description: >- This attribute defines the suffix that should follow the name of the entity. nullable: true maxLength: 31 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 foreignEntity: type: boolean description: >- This attribute designates whether the entity is a US person/Org or not. nullable: true default: false foreignTaxIdNumber: type: string description: > This attribute specifies the foreign Taxpayer Identification Number used for tax purposes in the country of residence. It will be utilized for 1042-S reporting. Must consist only of alphanumeric characters. maxLength: 25 nullable: true insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false startDate: type: string format: date description: > This attribute defines either the birth date of Individual or the start date of Nonindividual. Must be a current date or past date. nullable: true endDate: type: string format: date description: > This attribute defines either the deceased date of Individual or the end date of Nonindividual. Must be a current date or past date. nullable: true entityOfficerId: type: string format: uuid description: >- This attribute defines the primary officer Id associated to entity's account. nullable: true entityBranchAddressId: type: string format: uuid description: This attribute defines the branch Id associated to entity's account. nullable: true netWorth: description: > This attribute specifies the net worth currency value of the entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false gender: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false pronoun: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false race: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ethnicity: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false disability: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false incomeLevel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name - sortOrder properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false sortOrder: type: integer description: Indicates the sort order of the resource. militaryInformation: type: object description: The military information associated with this entity. properties: status: type: string description: This attribute indicates the military status of this entity. nullable: true enum: - Active Duty - Reserve - Inactive - Dependent activeDutyVerificationDate: type: string format: date description: This is the date active duty status was verified. nullable: true activeDutyStartDate: type: string format: date description: This date indicates the start date of active duty status. nullable: true activeDutySeparationDate: type: string format: date description: This date indicates the separation date from active duty status. nullable: true nullable: true lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true privacyOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Privacy Opt Out options. This value can only be set to true if the Institution's entity settings `AllowPrivacyOptOutAll` value is true. nullable: true default: false privacyActLastNoticeDate: type: string format: date-time description: > The timestamp of when the entity was last notified about the Privacy Act. Must be current date or a past date. nullable: true affiliateOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Affiliate Opt Out options. This value can only be set to true if the Institution's entity settings AllowAffiliateOptOutAll value is true. nullable: true default: false includeLegalEntity: type: boolean description: > This attribute represents the entity's inclusion to the FinCEN Customer Due Diligence (CDD) processes. If the value is set as false, the legal entity exclusion reason must be provided. nullable: true default: false legalEntityExclusionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false legalEntityId: type: string description: >- A unique alphanumeric identifier for legal entities participating in financial transactions. nullable: true maxLength: 20 taxInformation: type: object required: - irsReportable properties: taxIdCertificationStatus: type: string description: The status of the Tax Id certification. nullable: true enum: - IRS has generated B notice - Entity has certified the TIN provided - TIN certificate has been sent to entity taxIdCertificationDate: type: string format: date description: | The date the Tax Id was certified. Must be a current date or past date. nullable: true bNoticesSent: type: number format: int32 default: 0 description: | The number of B Notices sent to the Entity. Valid values: 0, 1, 2 nullable: true lastBNoticeDate: type: string format: date description: | The date the last B Notice was sent to the Entity. Must be a current date or past date. nullable: true irsReportable: type: string description: Indicates how the Entity will report to the IRS. nullable: false enum: - IRS Reportable - Foreign IRS Reportable - Non-IRS Reportable foreignEntityInformation: type: object properties: citizenshipCountry: type: object properties: numeric: type: string description: >- The unique ISO three numeric character code for the Country. minLength: 3 maxLength: 3 nullable: false alpha2: type: string description: The unique ISO two Alpha character code for the Country. minLength: 2 maxLength: 2 nullable: false alpha3: type: string description: >- The unique ISO three Alpha character code for the Country. Must contain 3 alpha characters. minLength: 3 maxLength: 3 nullable: false name: type: string description: The full name of the Country. maxLength: 255 nullable: false reportingChapter: type: string description: The Reporting Chapter used by the Entity. nullable: true enum: - Chapter 3 - Chapter 4 chapterExemption: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. chapterStatus: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. foreignCertificationInformation: type: object properties: w8Type: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 w8CertificationDate: type: string format: date description: | The date the W8 Form was certified. Must be a current date or past date. nullable: true w8ExpirationDate: type: string format: date description: | The date the W8 Form expires. Must be a future date. nullable: true giinId: type: string description: | The GIIN Id used by the Entity. nullable: true maxLength: 19 giinProvidedDate: type: string format: date description: | The date the GIIN was provided. Must be a current date or past date. nullable: true giinCertificationDate: type: string format: date description: | The date the GIIN was certified. Must be a current date or past date. nullable: true preferredContactVoiceId: type: string description: | The Id of the preferred phone number for voice calls. The value must reference an existing Phone Number for the Entity. nullable: true format: uuid preferredContactTextId: type: string description: | The Id of the preferred phone number for text messages. The value must reference an existing Phone Number for the Entity. nullable: true format: uuid preferredContactEmailId: type: string description: > The Id of the preferred contact method for emails. The value must reference an existing Digital Contact Point of Type 'Email' for the Entity. nullable: true format: uuid taxAddressId: type: string description: The Id of the tax address. nullable: true format: uuid mailingAddressId: type: string description: The Id of the mailing address. nullable: true format: uuid commercial: type: object properties: sicCode: type: string format: numeric only description: >- This attribute defines the Standard Industrial Classification (SIC) code used to classify the commercial entity by industry. minLength: 4 maxLength: 4 naicsCode: type: string format: numeric only description: >- This attribute defines the North American Industry Classification System (NAICS) code used to categorize the commercial entity based on primary economic activity. minLength: 4 maxLength: 4 grossAnnualRevenue: description: > This attribute specifies the gross annual revenue of a commercial entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false financialStatementDate: type: string format: date description: | This attribute defines the commercial financial statement date. Must be a current date or past date. nullable: true createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true addresses: type: array description: An array of addresses for the entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false phoneNumbers: type: array description: An array of phone numbers for the entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false identifications: type: array description: >- An array of Identification related information used to verify an entity's identity. nullable: true items: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: required: - id description: | The Id must be a valid Identification Type Id. allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true privacyOptOuts: type: array description: An array of Privacy Opt Out options. nullable: true items: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false affiliateOptOuts: type: array description: An array of Affiliate Opt Out options. nullable: true items: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. exceptionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false exceptionDate: type: string format: date description: | The date when the Opt Out Exception takes effect. Date must be current date or a future date. nullable: true revokeDate: type: string format: date description: | The date when the Opt Out is to be revoked. Date must be a current date or a future date. nullable: true - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false employments: type: array description: An array of Employments for the entity. nullable: true items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true employer: type: string description: This attribute defines the employer of the employment record. nullable: true maxLength: 255 occupation: type: string description: >- This attribute defines the occupation of the employment record. nullable: true maxLength: 255 startDate: type: string description: > This attribute defines the start month and year of the employment record (yyyy-MM). It must be a current month or past month. nullable: true example: 2024-12 endDate: type: string description: > This attribute defines the end month and year of the employment record (yyyy-MM). If both `startDate` and `endDate` are provided, `endDate` must be greater than or equal to `startDate`. nullable: true example: 2024-12 ficoScore: type: string format: numeric only description: > This attribute is the FICO score of the entity. A numerical representation of the credit risk that helps FIs decide whether to approve loans or credit cards. minLength: 3 maxLength: 3 taxReturnDate: type: string format: date-time description: | This attribute defines the commercial tax return date. Must be a current date or past date. nullable: true natureOfBusiness: type: string description: > This attribute defines the nature of business for the entity. It is a free-form text field that describes the primary business activity of the entity. nullable: true maxLength: 255 GetForeignTaxIdNumberResponse: type: object required: - id - taxIdNumber properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true taxIdNumber: type: string description: > This attribute specifies the foreign Taxpayer Identification Number used for tax purposes in the country of residence. It will be utilized for 1042-S reporting. Must consist only of alphanumeric characters. maxLength: 25 nullable: true GetTaxIdNumberResponse: type: object required: - id - taxIdNumber properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true ListEntitySearchResponse: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: | Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer ListEntitySearchModel: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: | This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: | Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false SearchEntityRequest: type: object description: > This element is used to search for an Entity using different address components such as Name, Tax Id Number, Phone Number, Digital Contact Point and Address. Atleast one of `taxIdNumber`, `phoneNumber`, `digitalContactPoint`, `address` or `name` element must contain a value. properties: taxIdNumber: type: string description: > This element identifies the value used to search for an Entity by Tax Id Number. Matching Entities Tax Id Number Identifiers must contain value presented. It must contain only numeric characters. nullable: true minLength: 3 name: type: string description: > This element identifies the value used to search for an Entity by name. All name fields identified in `nameSearchFields` element will be searched. nullable: true minLength: 3 phoneNumber: type: string description: > This element identifies the value used to search for an Entity by Phone Number. Matching Entities Phone Numbers must contain value presented. Must be a numeric value. nullable: true minLength: 3 digitalContactPoint: type: string description: > This element identifies the value used to search for an Entity by Digital Contact Point. Matching Entities Digital Contact Point Identifiers must contain value presented. nullable: true minLength: 3 address: type: string description: > This element is used to search for an Entity using different address components. Accepts any alphanumeric value. String separators will be stripped out and not included with search terms. nullable: true minLength: 3 maxLength: 1024 SemanticSearchEntityRequest: type: object description: > Perform a Semantic Search using natural language processing to find relevant Entities. properties: semanticSearchText: type: string description: The text input used to perform the semantic search for entities. minLength: 3 SearchEntityResponse: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: | Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer searchEntitiesAutoCompleteResponse: type: object properties: entities: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true name: type: string description: The name of the entity. nullable: true SearchEntityModel: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: | This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: | Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false ReplaceEntityRequest: allOf: - type: object required: - entityType - taxIdType - entitySubtypeId - lastName - taxInformation properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityType: type: string description: | This attribute identifies the entity type. nullable: false enum: - Individual - Nonindividual entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: > If `IsEntitySubtypeMandatory` of `EntitySettings` is true, this property must have an Id value. The entity subtype must also be valid for the entity type based on `EntityTypesApplicable` settings. taxIdType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: > The tax id type must be valid for the entity type based on `EntityTypesApplicable` settings. taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: | Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 suffix: type: string description: >- This attribute defines the suffix that should follow the name of the entity. nullable: true maxLength: 31 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 foreignEntity: type: boolean description: >- This attribute designates whether the entity is a US person/Org or not. nullable: true default: false foreignTaxIdNumber: type: string description: > This attribute specifies the foreign Taxpayer Identification Number used for tax purposes in the country of residence. It will be utilized for 1042-S reporting. Must consist only of alphanumeric characters. maxLength: 25 nullable: true insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false startDate: type: string format: date description: > This attribute defines either the birth date of Individual or the start date of Nonindividual. Must be a current date or past date. nullable: true endDate: type: string format: date description: > This attribute defines either the deceased date of Individual or the end date of Nonindividual. Must be a current date or past date. nullable: true entityOfficerId: type: string format: uuid description: >- This attribute defines the primary officer Id associated to entity's account. nullable: true entityBranchAddressId: type: string format: uuid description: >- This attribute defines the branch Id associated to entity's account. nullable: true natureOfBusiness: type: string description: > This attribute defines the nature of business for the entity. It is a free-form text field that describes the primary business activity of the entity. nullable: true maxLength: 255 taxReturnDate: type: string format: date-time description: | This attribute defines the commercial tax return date. Must be a current date or past date. nullable: true ficoScore: type: string format: numeric only description: > This attribute is the FICO score of the entity. A numerical representation of the credit risk that helps FIs decide whether to approve loans or credit cards. minLength: 3 maxLength: 3 netWorth: description: > This attribute specifies the net worth currency value of the entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false gender: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. pronoun: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. race: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. ethnicity: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. disability: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. incomeLevel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. militaryInformation: allOf: - type: object description: The military information associated with this entity. properties: status: type: string description: >- This attribute indicates the military status of this entity. nullable: true enum: - Active Duty - Reserve - Inactive - Dependent activeDutyVerificationDate: type: string format: date description: This is the date active duty status was verified. nullable: true activeDutyStartDate: type: string format: date description: >- This date indicates the start date of active duty status. nullable: true activeDutySeparationDate: type: string format: date description: >- This date indicates the separation date from active duty status. nullable: true nullable: true - description: >- For `Nonindividual` entity type, providing a value will result in a validation error indicating that it is not applicable. lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true privacyOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Privacy Opt Out options. This value can only be set to true if the Institution's entity settings `AllowPrivacyOptOutAll` value is true. nullable: true default: false privacyActLastNoticeDate: type: string format: date-time description: > The timestamp of when the entity was last notified about the Privacy Act. Must be current date or a past date. nullable: true affiliateOptOutAll: type: boolean description: > Designates if the entity has chosen to opt out of all Affiliate Opt Out options. This value can only be set to true if the Institution's entity settings AllowAffiliateOptOutAll value is true. nullable: true default: false includeLegalEntity: type: boolean description: > This attribute represents the entity's inclusion to the FinCEN Customer Due Diligence (CDD) processes. If the value is set as false, the legal entity exclusion reason must be provided. nullable: true default: false legalEntityExclusionReason: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - description: >- The attribute is required when `includeLegalEntity` is set to `false`. legalEntityId: type: string description: >- A unique alphanumeric identifier for legal entities participating in financial transactions. nullable: true maxLength: 20 taxInformation: type: object required: - irsReportable properties: taxIdCertificationStatus: type: string description: The status of the Tax Id certification. nullable: true enum: - IRS has generated B notice - Entity has certified the TIN provided - TIN certificate has been sent to entity taxIdCertificationDate: type: string format: date description: | The date the Tax Id was certified. Must be a current date or past date. nullable: true bNoticesSent: type: number format: int32 default: 0 description: | The number of B Notices sent to the Entity. Valid values: 0, 1, 2 nullable: true lastBNoticeDate: type: string format: date description: | The date the last B Notice was sent to the Entity. Must be a current date or past date. nullable: true irsReportable: type: string description: Indicates how the Entity will report to the IRS. nullable: false enum: - IRS Reportable - Foreign IRS Reportable - Non-IRS Reportable foreignEntityInformation: type: object properties: citizenshipCountry: type: object properties: alpha2: description: > Must be a valid ISO 3166-1 alpha-2 country code that should be present in `CountryCode` settings. type: string minLength: 2 maxLength: 2 nullable: false reportingChapter: type: string description: The Reporting Chapter used by the Entity. nullable: true enum: - Chapter 3 - Chapter 4 chapterExemption: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false chapterStatus: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false foreignCertificationInformation: type: object properties: w8Type: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false w8CertificationDate: type: string format: date description: | The date the W8 Form was certified. Must be a current date or past date. nullable: true w8ExpirationDate: type: string format: date description: | The date the W8 Form expires. Must be a future date. nullable: true giinId: type: string description: | The GIIN Id used by the Entity. nullable: true maxLength: 19 giinProvidedDate: type: string format: date description: | The date the GIIN was provided. Must be a current date or past date. nullable: true giinCertificationDate: type: string format: date description: | The date the GIIN was certified. Must be a current date or past date. nullable: true commercial: type: object properties: sicCode: type: string format: numeric only description: >- This attribute defines the Standard Industrial Classification (SIC) code used to classify the commercial entity by industry. minLength: 4 maxLength: 4 naicsCode: type: string format: numeric only description: >- This attribute defines the North American Industry Classification System (NAICS) code used to categorize the commercial entity based on primary economic activity. minLength: 4 maxLength: 4 grossAnnualRevenue: description: > This attribute specifies the gross annual revenue of a commercial entity. The default value for CurrencyType is USD. Currently the only valid value is USD. nullable: true type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false financialStatementDate: type: string format: date description: > This attribute defines the commercial financial statement date. Must be a current date or past date. nullable: true createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true - type: object properties: preferredContactVoiceId: type: string description: > The Id of the preferred phone number for voice calls. The value must reference an existing Phone Number for the Entity. nullable: true format: uuid preferredContactTextId: type: string description: > The Id of the preferred phone number for text messages. The value must reference an existing Phone Number for the Entity. nullable: true format: uuid preferredContactEmailId: type: string description: > The Id of the preferred contact method for emails. The value must reference an existing Digital Contact Point of Type 'Email' for the Entity. nullable: true format: uuid taxAddressId: type: string description: The Id of the tax address. nullable: true format: uuid mailingAddressId: type: string description: The Id of the mailing address. nullable: true format: uuid ReplaceForeignTaxIdNumberRequest: type: object required: - taxIdNumber properties: taxIdNumber: type: string description: > This attribute specifies the foreign Taxpayer Identification Number used for tax purposes in the country of residence. It will be utilized for 1042-S reporting. Must consist only of alphanumeric characters. maxLength: 25 nullable: true ReplaceTaxIdNumberRequest: type: object required: - taxIdNumber properties: taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true TaxIdNumberExistsRequest: type: object required: - taxIdNumber properties: taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true CreateIdentificationRequest: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: | The Id must be a valid Identification Type Id. idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true CreateIdentificationResponse: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true GetIdentificationResponse: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: required: - id description: | The Id must be a valid Identification Type Id. allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true ListIdentificationResponse: type: object properties: identifications: type: array items: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: required: - id description: | The Id must be a valid Identification Type Id. allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true ReplaceIdentificationRequest: type: object required: - idNumber - idType properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true idType: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: | The Id must be a valid Identification Type Id. idNumber: type: string description: >- This attribute defines the identification Number corresponding to the identification type defined. nullable: false maxLength: 255 issuedBy: type: string description: >- This attribute defines the authority who issued the identification document. nullable: true maxLength: 255 placeIssued: type: string description: >- This attribute defines the identification document issued place or city. nullable: true maxLength: 255 issuedDate: type: string format: date description: > This attribute defines the issued date of the identification document. Must be a current date or past date. nullable: true expirationDate: type: string format: date description: > This attribute defines the expiration date of the identification document. Must be a future date. nullable: true CreatePhoneRequest: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: > Internal phone extension designation for a multi-line phone number. Numeric only. nullable: true maxLength: 10 countryCallingCode: type: string description: | International country code with omitted prefix. Numeric only. nullable: true label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: The Id must be a valid Phone Number Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false CreatePhoneResponse: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true GetPhoneNumberResponse: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false ListPhoneNumberResponse: type: object properties: phoneNumbers: type: array items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false ReplacePhoneNumberRequest: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: > Internal phone extension designation for a multi-line phone number. Numeric only. nullable: true maxLength: 10 countryCallingCode: type: string description: | International country code with omitted prefix. Numeric only. nullable: true label: type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id description: The Id must be a valid Phone Number Label Id. optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false GetPrivacyOptOutResponse: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false ListPrivacyOptOutResponse: type: object properties: PrivacyOptOuts: type: array items: allOf: - type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. - type: object properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false ReplacePrivacyOptOutRequest: type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true value: type: boolean description: This attribute defines the value of the Opt Out. DownloadResponse: type: string format: binary description: The content of the downloaded file. readOnly: true GenerateListResponse: type: object properties: ids: type: array items: type: string format: uuid description: The unique identifier of the resource. readOnly: true GenerateResponse: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true ListScreeningsResponse: type: object properties: screenings: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityId: type: string format: uuid description: Unique identifier of the Entity. nullable: true createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true CreateScreeningResponse: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityId: type: string format: uuid description: Unique identifier of the Entity. nullable: true createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true ListAddressChangeResponse: type: object properties: addressChanges: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityId: type: string format: uuid description: Unique identifier of the Entity. nullable: true userId: type: string format: uuid description: Unique identifier of the user. nullable: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false isTax: type: boolean description: | Indicates this as a tax address. Only one address can be set as a tax address. nullable: true default: false isMailing: type: boolean description: | Indicates this as a mailing address. Only one address can be set as a mailing address. nullable: true default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: The time zone in which the address is located. nullable: true maxLength: 5 timeStamp: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true ListPhoneChangeResponse: type: object properties: phoneChanges: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityId: type: string format: uuid description: Unique identifier of the Entity. nullable: true userId: type: string format: uuid description: Unique identifier of the user. nullable: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false timeStamp: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true ListContactChangeResponse: type: object properties: contactChanges: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entityId: type: string format: uuid description: Unique identifier of the Entity. nullable: true userId: type: string format: uuid description: Unique identifier of the user. nullable: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false timeStamp: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true CreateRelationshipRequest: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: | The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true CreateRelationshipResponse: type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true GetRelationshipResponse: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: | The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: | This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true SearchRelationshipRequest: type: object properties: entityAssets: type: array description: >- At least one of the entityId or AssetId must be present in each item of the array. Additionally, the AssetType can be either empty, 'Accounts', or 'Cards'. items: type: object properties: entityId: type: string format: uuid description: | The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards SearchRelationshipResponse: type: object properties: paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: | The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: | This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true ReplaceRelationshipRequest: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: | The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true SwitchEntityRequest: type: object properties: entityId: type: string format: uuid description: | The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false CreateRelationshipTypeRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: | This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ReplaceRelationshipTypeRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: | This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false GetRelationshipTypeResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: | This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ListRelationshipTypesResponse: type: object properties: relationshipTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: | This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false SwitchIrsReportableRelationshipRequest: type: object properties: currentIrsReportableRelationship: type: object description: > This object is used to specify the current IRS reportable relationship. It contains the ID of the current IRS reportable relationship. Relationship Type can be specified to update the relationship type of the current IRS reportable relationship. Delete can be specified to delete the current IRS reportable relationship. required: - id properties: id: type: string format: uuid description: >- The unique identifier for the current IRS reportable relationship. nullable: false relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id delete: type: boolean description: | This describes the delete status of this resource. If set to true, the resource will be deleted. If set to false, the resource will not be deleted. nullable: true default: false newIrsReportableRelationship: type: object description: > This object is used to specify the new IRS reportable relationship. It contains the ID of the new IRS reportable relationship. Relationship Type can be specified to update the relationship type of the new IRS reportable relationship. required: - id properties: id: type: string format: uuid description: The unique identifier for the new IRS reportable relationship. nullable: false relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false required: - id ListRelationshipChangeResponse: type: object properties: relationshipChanges: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: | The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: | This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 timeStamp: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true operation: type: string description: the archive operation on the resource. maxLength: 255 readOnly: true CreateTaxIdTypeRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: | An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false tinRequired: type: boolean description: Indicates if a tax id number is required. nullable: true default: false GetTaxIdTypeResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: | An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false tinRequired: type: boolean description: Indicates if a tax id number is required. nullable: true default: false ListTaxIdTypesResponse: type: object properties: taxIdTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false tinRequired: type: boolean description: Indicates if a tax id number is required. nullable: true default: false CreateEntitySubtypeRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: | An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false GetEntitySubtypeResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: | An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ListEntitySubtypesResponse: type: object properties: entitySubTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false CreateInsiderRoleRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false GetInsiderRoleResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ListInsiderRolesResponse: type: object properties: taxIdTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false CreateGenderRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false GetGenderResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ListGendersResponse: type: object properties: taxIdTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false CreateAddressLabelRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false GetAddressLabelResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ListAddressLabelResponse: type: object properties: addressLabels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false CreateIncomeLevelRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - sortOrder properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false sortOrder: type: integer description: Indicates the sort order of the resource. GetIncomeLevelResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - sortOrder properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false sortOrder: type: integer description: Indicates the sort order of the resource. ListIncomeLevelResponse: type: object properties: incomeLevels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - sortOrder properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false sortOrder: type: integer description: Indicates the sort order of the resource. ReplaceIncomeLevelsRequest: type: object properties: incomeLevels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name - sortOrder properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false sortOrder: type: integer description: Indicates the sort order of the resource. CreatePronounRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false GetPronounResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ListPronounResponse: type: object properties: pronouns: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false CreateRaceRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false GetRaceResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ListRacesResponse: type: object properties: races: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false CreateIdentificationTypeRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false GetIdentificationTypeResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ListIdentificationTypesResponse: type: object properties: identificationTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false CreateEthnicityRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false GetEthnicityResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ListEthnicitiesResponse: type: object properties: ethnicities: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false CreateDisabilityRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false GetDisabilityResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ListDisabilitiesResponse: type: object properties: disabilities: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false CreatePrivacyOptOutTypeRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false GetPrivacyOptOutTypeResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false ListPrivacyOptOutTypeResponse: type: object properties: privacyOptOutTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false CreateDigitalContactPointLabelRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false GetDigitalContactPointLabelResponse: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ListDigitalContactPointLabelsResponse: type: object properties: digitalContactPointLabels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false CreatePhoneLabelRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false GetPhoneLabelResponse: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ListPhoneLabelsResponse: type: object properties: phoneLabels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ReplacePhoneSettingsRequest: type: object properties: defaultCountryCallingCode: type: string description: >- Default country calling code value. Tha length of country calling code should not exceed 3. nullable: true default: '001' GetPhoneSettingsResponse: type: object properties: defaultCountryCallingCode: type: string description: >- Default country calling code value. Tha length of country calling code should not exceed 3. nullable: true default: '001' ReplaceEntitySettingsRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: isEntitySubtypeMandatory: type: boolean description: >- Indicates whether the entity subtype resource is mandatory or not. nullable: true default: true isIdentificationMandatory: type: boolean description: >- Indicates whether the identification resource is mandatory or not. nullable: true default: true allowPrivacyOptOutAll: type: boolean description: Indicates whether the privacy opt out all option is provided. nullable: true default: true allowAffiliateOptOutAll: type: boolean description: Indicates whether the affiliate opt out all option is provided. nullable: true default: true defaultAddressLabelId: type: string format: uuid description: The default address label id. nullable: true defaultAffiliateOptOutExceptionReasonId: type: string format: uuid description: The default affiliate opt out exception reason id. nullable: true defaultDigitalContactPointLabelId: type: string format: uuid description: The default digital contact point label id. nullable: true defaultIncomeLevelId: type: string format: uuid description: The default income level id. nullable: true defaultPhoneLabelId: type: string format: uuid description: The default phone label id. nullable: true defaultInsiderRoleId: type: string format: uuid description: The default insider role id. nullable: true defaultLegalEntityExclusionReasonId: type: string format: uuid description: The default legal entity exclusion reason id. nullable: true defaultIndividualTaxIdTypeId: type: string format: uuid description: The default individual tax id type id. nullable: true defaultNonindividualTaxIdTypeId: type: string format: uuid description: The default nonindividual tax id type id. nullable: true defaultIndividualEntitySubtypeId: type: string format: uuid description: The default individual entity subtype id. nullable: true defaultNonindividualEntitySubtypeId: type: string format: uuid description: The default nonindividual entity subtype id. nullable: true w8TaxReportingAutomateWithholding: type: boolean description: Indicates if automatic withholding should occur on expired W8s. nullable: true default: true w8TaxReportingExpirationNoticeLeadDays: type: integer description: > Number of days before W8 expiration date to produce the W8 expiration notice. Value must be between 0 and 999. nullable: true default: 0 GetEntitySettingsResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: isEntitySubtypeMandatory: type: boolean description: >- Indicates whether the entity subtype resource is mandatory or not. nullable: true default: true isIdentificationMandatory: type: boolean description: >- Indicates whether the identification resource is mandatory or not. nullable: true default: true allowPrivacyOptOutAll: type: boolean description: Indicates whether the privacy opt out all option is provided. nullable: true default: true allowAffiliateOptOutAll: type: boolean description: Indicates whether the affiliate opt out all option is provided. nullable: true default: true defaultAddressLabelId: type: string format: uuid description: The default address label id. nullable: true defaultAffiliateOptOutExceptionReasonId: type: string format: uuid description: The default affiliate opt out exception reason id. nullable: true defaultDigitalContactPointLabelId: type: string format: uuid description: The default digital contact point label id. nullable: true defaultIncomeLevelId: type: string format: uuid description: The default income level id. nullable: true defaultPhoneLabelId: type: string format: uuid description: The default phone label id. nullable: true defaultInsiderRoleId: type: string format: uuid description: The default insider role id. nullable: true defaultLegalEntityExclusionReasonId: type: string format: uuid description: The default legal entity exclusion reason id. nullable: true defaultIndividualTaxIdTypeId: type: string format: uuid description: The default individual tax id type id. nullable: true defaultNonindividualTaxIdTypeId: type: string format: uuid description: The default nonindividual tax id type id. nullable: true defaultIndividualEntitySubtypeId: type: string format: uuid description: The default individual entity subtype id. nullable: true defaultNonindividualEntitySubtypeId: type: string format: uuid description: The default nonindividual entity subtype id. nullable: true w8TaxReportingAutomateWithholding: type: boolean description: Indicates if automatic withholding should occur on expired W8s. nullable: true default: true w8TaxReportingExpirationNoticeLeadDays: type: integer description: > Number of days before W8 expiration date to produce the W8 expiration notice. Value must be between 0 and 999. nullable: true default: 0 CreateAffiliateOptOutTypeRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false GetAffiliateOptOutTypeResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false ListAffiliateOptOutTypeResponse: type: object properties: affiliateOptOutTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false CreateAffiliateOptOutExceptionReasonRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false GetAffiliateOptOutExceptionReasonResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ListAffiliateOptOutExceptionReasonResponse: type: object properties: affiliateOptOutExceptionReasons: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false CreateLegalEntityExclusionReasonRequest: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false GetLegalEntityExclusionReasonResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ListLegalEntityExclusionReasonResponse: type: object properties: legalEntityExclusionReasons: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false GetChapterExemptionResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. ListChapterExemptionResponse: type: object properties: chapterExemptions: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. GetChapterStatusResponse: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. ListChapterStatusResponse: type: object properties: chapterStatuses: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. GetW8TypeResponse: allOf: - type: object properties: id: type: string description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 ListW8TypeResponse: type: object properties: W8Types: type: array items: allOf: - type: object properties: id: type: string description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 ListSettingsResponse: type: object properties: entitySettings: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: isEntitySubtypeMandatory: type: boolean description: >- Indicates whether the entity subtype resource is mandatory or not. nullable: true default: true isIdentificationMandatory: type: boolean description: >- Indicates whether the identification resource is mandatory or not. nullable: true default: true allowPrivacyOptOutAll: type: boolean description: >- Indicates whether the privacy opt out all option is provided. nullable: true default: true allowAffiliateOptOutAll: type: boolean description: >- Indicates whether the affiliate opt out all option is provided. nullable: true default: true defaultAddressLabelId: type: string format: uuid description: The default address label id. nullable: true defaultAffiliateOptOutExceptionReasonId: type: string format: uuid description: The default affiliate opt out exception reason id. nullable: true defaultDigitalContactPointLabelId: type: string format: uuid description: The default digital contact point label id. nullable: true defaultIncomeLevelId: type: string format: uuid description: The default income level id. nullable: true defaultPhoneLabelId: type: string format: uuid description: The default phone label id. nullable: true defaultInsiderRoleId: type: string format: uuid description: The default insider role id. nullable: true defaultLegalEntityExclusionReasonId: type: string format: uuid description: The default legal entity exclusion reason id. nullable: true defaultIndividualTaxIdTypeId: type: string format: uuid description: The default individual tax id type id. nullable: true defaultNonindividualTaxIdTypeId: type: string format: uuid description: The default nonindividual tax id type id. nullable: true defaultIndividualEntitySubtypeId: type: string format: uuid description: The default individual entity subtype id. nullable: true defaultNonindividualEntitySubtypeId: type: string format: uuid description: The default nonindividual entity subtype id. nullable: true w8TaxReportingAutomateWithholding: type: boolean description: >- Indicates if automatic withholding should occur on expired W8s. nullable: true default: true w8TaxReportingExpirationNoticeLeadDays: type: integer description: > Number of days before W8 expiration date to produce the W8 expiration notice. Value must be between 0 and 999. nullable: true default: 0 addressLabels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false affiliateOptOutExceptionReasons: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false affiliateOptOutTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false chapterExemptions: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. chapterStatuses: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - code - reportingChapter properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 code: type: string description: The code for resource. reportingChapter: type: string enum: - Chapter 3 - Chapter 4 description: The reporting chapter for resource. countryCodes: type: array items: type: object properties: numeric: type: string description: The unique ISO three numeric character code for the Country. minLength: 3 maxLength: 3 nullable: false alpha2: type: string description: The unique ISO two Alpha character code for the Country. minLength: 2 maxLength: 2 nullable: false alpha3: type: string description: >- The unique ISO three Alpha character code for the Country. Must contain 3 alpha characters. minLength: 3 maxLength: 3 nullable: false name: type: string description: The full name of the Country. maxLength: 255 nullable: false digitalContactPointLabels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false disabilities: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false entitySubtypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false ethnicities: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false genders: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false identificationTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false incomeLevels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - sortOrder properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false sortOrder: type: integer description: Indicates the sort order of the resource. insiderRoles: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false legalEntityExclusionReasons: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneLabels: type: array items: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneSettings: type: object properties: defaultCountryCallingCode: type: string description: >- Default country calling code value. Tha length of country calling code should not exceed 3. nullable: true default: '001' privacyOptOutTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false defaultValue: type: boolean description: Designates which resource is to be used as default. default: false noOptOut: type: boolean description: Indicates the resource cannot be opted out of. default: false pronouns: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false races: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false stateCodes: type: array items: type: object properties: alpha2: type: string description: The unique ISO two Alpha character code for the State. minLength: 2 maxLength: 2 nullable: false fips: type: string description: The unique FIPS code for the State. maxLength: 2 nullable: false name: type: string description: The full name of the State. maxLength: 255 nullable: false taxIdTypes: type: array items: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false tinRequired: type: boolean description: Indicates if a tax id number is required. nullable: true default: false w8Types: type: array items: allOf: - type: object properties: id: type: string description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 ListCountryCodesResponse: type: object properties: countryCodes: type: array items: type: object properties: numeric: type: string description: The unique ISO three numeric character code for the Country. minLength: 3 maxLength: 3 nullable: false alpha2: type: string description: The unique ISO two Alpha character code for the Country. minLength: 2 maxLength: 2 nullable: false alpha3: type: string description: >- The unique ISO three Alpha character code for the Country. Must contain 3 alpha characters. minLength: 3 maxLength: 3 nullable: false name: type: string description: The full name of the Country. maxLength: 255 nullable: false GetCountryCodesResponse: type: object properties: numeric: type: string description: The unique ISO three numeric character code for the Country. minLength: 3 maxLength: 3 nullable: false alpha2: type: string description: The unique ISO two Alpha character code for the Country. minLength: 2 maxLength: 2 nullable: false alpha3: type: string description: >- The unique ISO three Alpha character code for the Country. Must contain 3 alpha characters. minLength: 3 maxLength: 3 nullable: false name: type: string description: The full name of the Country. maxLength: 255 nullable: false ListCountyCodesResponse: type: object properties: countyCodes: type: array items: type: object properties: fips: type: string description: The unique FIPS code for the County. maxLength: 5 nullable: false name: type: string description: The name of the County. maxLength: 255 nullable: false GetCountyCodesResponse: type: object properties: fips: type: string description: The unique FIPS code for the County. maxLength: 5 nullable: false name: type: string description: The name of the County. maxLength: 255 nullable: false ListStateCodesResponse: type: object properties: stateCodes: type: array items: type: object properties: alpha2: type: string description: The unique ISO two Alpha character code for the State. minLength: 2 maxLength: 2 nullable: false fips: type: string description: The unique FIPS code for the State. maxLength: 2 nullable: false name: type: string description: The full name of the State. maxLength: 255 nullable: false GetStateCodesResponse: type: object properties: alpha2: type: string description: The unique ISO two Alpha character code for the State. minLength: 2 maxLength: 2 nullable: false fips: type: string description: The unique FIPS code for the State. maxLength: 2 nullable: false name: type: string description: The full name of the State. maxLength: 255 nullable: false EntityAggregationSearchRequest: type: object properties: name: type: string description: >- any part of a name, (first name, last name, preferred name). You can put spaces between names to denote another part of a name minLength: 3 maxLength: 255 taxIdNumber: type: string description: The tax id number or ssn of the entity nullable: true RelationshipAggregationSearchRequest: type: object properties: assetId: type: string format: uuid description: > The unique identifier given to an account. This value must be an existing account identifier. This is the Account Id not the account number nullable: true assetType: type: string description: The Asset Type. Currently the only accepted values is Accounts nullable: true example: Accounts enum: - Accounts AccountAggregationSearchRequest: type: object properties: accountNumber: type: string description: The human readable account number. nullable: true accountType: type: string description: The account type. lower case only nullable: true example: checking enum: - checking - savings AccountListRequest: type: object properties: accountIds: type: array description: An array of strings items: type: string format: uuid description: AccountId nullable: false nullable: false CardListRequest: type: object properties: cardIds: type: array description: An array of strings items: type: string description: The unique token given to a card. nullable: false nullable: false SearchAggregateRelationshipResponse: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: | Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: | The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: The unique identifier given to an account. nullable: false linkType: type: string description: The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer SearchAggregateAccountListResponse: type: object properties: accountsResponse: type: array items: type: object properties: entities: type: array items: type: object required: - firstName - lastName properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true entitySubtype: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name - entityTypesApplicable properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 entityTypesApplicable: type: array description: > An array of Entity Types that this resource is applicable to. See Entity Types resource for valid values. The values of the property array items must be unique. nullable: false items: type: string isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false taxIdNumber: type: string description: > Identifies the Tax Id Number for the Entity. Must only consist of 9 numeric characters for the following TaxIdTypes: * `SocialSecurityNumber` * `IndividualTaxpayerIdentificationNumber` * `EmployerIdentificationNumber` All other TaxIdTypes will not be validated. nullable: true title: type: string description: >- This attribute defines the title that should precede the name of the entity. For example, MR, MS, or DR. nullable: true maxLength: 31 firstName: type: string description: > This attribute defines the first name associated with the entity. Validation is based on Entity Type: * `Individual` - A value is required. * `Nonindividual` - Not applicable. Value must be null. nullable: true maxLength: 255 middleName: type: string description: > This attribute specifies the middle name of the entity. Not applicable for `Nonindividual` entity types and the value must be null. nullable: true maxLength: 255 lastName: type: string description: | Defines the last name of the entity. For Nonindividual types, it serves as the entityName. Required for all entity types. nullable: false maxLength: 255 preferredName: type: string description: >- This attribute defines the preferred name associated with the entity. nullable: true maxLength: 255 lastContactDate: type: string format: date-time description: | The timestamp of when the entity was last contacted. Must be current date or a past date. nullable: true vipEntity: type: boolean description: This attribute represents the entity's VIP status. nullable: true default: false insiderRole: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false phoneNumbers: type: array description: An array of phone numbers for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - phoneNumber - label properties: phoneNumber: type: string description: The unformatted numeric only phone number. nullable: false minLength: 10 maxLength: 12 extension: type: string description: >- The internal phone extension designation for a multi-line phone number. nullable: true maxLength: 10 countryCallingCode: type: string description: >- International country code with omitted prefix. nullable: true label: allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object properties: name: type: string description: The full name of the Phone Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false digitalContactPoints: type: array description: An array of digital contact points for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 details: type: object required: - identifier - type - label properties: identifier: type: string description: The contact point identifier. nullable: false maxLength: 2048 type: type: string description: >- This attribute defines the Digital Contact Point Type. nullable: false enum: - Email - Website - Twitter - Facebook label: required: - id allOf: - type: object properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true - type: object required: - name properties: name: type: string description: >- The full name of the Digital Contact Point Label. maxLength: 255 nullable: false isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false addresses: type: array description: An array of addresses for the Entity. nullable: true items: type: object required: - details properties: id: type: string format: uuid description: The unique identifier of the resource. readOnly: true details: type: object required: - lines - postalCode properties: lines: type: array description: >- The individual lines of the address. Must have at least one element. items: type: string nullable: false maxLength: 255 city: type: string description: The city in which the address is located. nullable: true maxLength: 255 region: type: string description: > The region or state in which the address is located. Must use the unique ISO Alpha two character state (region) code for US addresses. If the Country is not US, this can be any value. nullable: true maxLength: 255 postalCode: type: string description: | The postal code for the address. nullable: false maxLength: 11 county: type: string description: > The county for the address. Valid for US addresses only. If the region is provided, this value must match the state (region) as per the FIPS code. nullable: true maxLength: 255 country: type: string description: >- The unique ISO Alpha two character code for the Country. nullable: true maxLength: 255 geoCoordinates: nullable: true type: object required: - latitude - longitude properties: latitude: type: number description: >- The number of degrees north (positive) or south (negative) from the equator. nullable: false minimum: -90 maximum: 90 longitude: type: number description: >- The number of degrees east (positive) or west (negative) from the prime meridian. nullable: false minimum: -180 maximum: 180 timeZone: type: string format: IANA_STD_abbreviation description: The time zone in which the address is located. nullable: true maxLength: 5 description: type: string description: A short identifying description for the resource. nullable: true maxLength: 255 seasonalStartDate: type: string format: date description: >- This attribute defines the start date for Seasonal Addresses. nullable: true seasonalEndDate: type: string format: date description: >- This attribute defines the end date for Seasonal Addresses. addressLabel: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the unique identifier of the referenced resource. nullable: false - type: object required: - name properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isForeign: type: boolean description: Indicates the address is in a foreign country. nullable: true default: false censusTract: type: object properties: stateCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the State in which the Address is located. Must be a two digit numeric string. minLength: 2 maxLength: 2 countyCode: type: string format: numeric only description: > This attribute defines the FIPS Code for the County in which the Address is located. Must be a two digit numeric string. minLength: 3 maxLength: 3 tractCode: type: string format: numeric only description: > This attribute defines the Code for the Census Tract in which the Address is located. Must be a two digit numeric string. minLength: 6 maxLength: 6 msaCode: type: string format: numeric only description: > This attribute defines the Code for the Metropolitan Statistical Area (MSA) in which the Address is located. Must be a two digit numeric string. minLength: 5 maxLength: 5 craLocation: type: boolean description: >- This attribute indicates if the Address is located in a qualifying Community Reinvestment Act (CRA) area. default: false optOut: type: boolean description: >- Opting out of marketing and advertising communications for this point of contact. nullable: true default: false relationships: type: array items: type: object required: - id - entityId - assetId - assetType - relationshipType properties: id: type: string format: uuid description: The unique identifier for relationship. readOnly: true entityId: type: string format: uuid description: | The unique identifier given to an entity. This value must be an existing entity identifier. nullable: false assetId: type: string description: >- The unique identifier given to an asset. This value must be an existing asset identifier in the service defined by assetType. nullable: false assetType: type: string description: > Describes the domain of the asset. Identifier mapping for asset id based on asset type: * `Accounts` - accountId * `Cards` - cardId nullable: true enum: - Accounts - Cards relationshipType: allOf: - type: object properties: id: type: string format: uuid description: >- This attribute defines the relationship type Id associated to entity's account. nullable: false - type: object required: - name - liability - fdxReference properties: name: type: string description: Describes the name of this resource. nullable: false maxLength: 255 liability: type: string description: > This describes the types of liability. The various liabilities are No, Indirect, and Direct. nullable: false enum: - 'No' - Indirect - Direct fdxReference: type: string description: > This describes the reference to the FDX AccountHolderRelationship Specification. nullable: false enum: - NOT_APPLICABLE - AUTHORIZED_USER - BUSINESS - FOR_BENEFIT_OF - FOR_BENEFIT_OF_PRIMARY - FOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SECONDARY - >- FOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTED - FOR_BENEFIT_OF_SOLE_OWNER_RESTRICTED - POWER_OF_ATTORNEY - PRIMARY - PRIMARY_BORROWER - PRIMARY_JOINT - PRIMARY_JOINT_TENANTS - SECONDARY - SECONDARY_BORROWER - SECONDARY_JOINT - SECONDARY_JOINT_TENANTS - SOLE_OWNER - TRUSTEE - UNIFORM_TRANSFER_TO_MINOR isInactive: type: boolean description: Describes the status of this resource. nullable: false default: false isOwner: type: boolean description: >- Indicates ownership to an asset. Default is true when no relationship exists for the assetId. nullable: true default: false isIrsReportableEntity: type: boolean description: >- Indicate if the entity’s TIN is going to be used for IRS reporting. Default is true when assetType is Accounts and no relationship exists for the assetId. nullable: true accountPreferredName: type: string description: Preferred Name describing the account. nullable: true maxLength: 255 createdDate: type: string format: date-time description: The timestamp of when the resource was created. readOnly: true accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: >- This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: >- This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false accountStatus: type: string description: This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off accountStatusDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: >- This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc. nullable: false cycleDay: type: integer description: >- This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: >- This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: >- This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: >- This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: >- This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: >- This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: >- This attribute defines the date the account is charged off. nullable: true chargedOffAmount: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false autoClose: type: boolean description: >- This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: >- This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: >- This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: >- This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: >- This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: >- This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: >- This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: >- This attribute defines the interest rate of the account. nullable: true balances: type: array items: type: object properties: accountId: description: >- This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: >- This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings nullable: false accountStatus: type: string description: This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off nullable: false availableBalCalcSettingId: type: string format: uuid description: >- This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: >- This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the current balance of the account. holds: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines total holds for the account. float: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance that excludes overdraft protection. overdraftLimit: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: >- This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: type: object properties: value: type: string description: This defines the amount value. nullable: false currencyType: type: string description: >- The ISO 4217 three character currency type. USD is the default value. nullable: true default: usd additionalProperties: false description: >- This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. cards: type: array items: type: object properties: CardToken: type: string description: The unique token given to a card. nullable: false CardProductId: type: string format: uuid description: The identifier given to a card product. nullable: false CardHolderId: type: string format: uuid description: The entityId given to a card hold. nullable: false CardHolderAddressId: type: string format: uuid description: The unique identifier for and address. nullable: false ExpirationDate: type: string description: The expiration date of the card in MM/YY format. pattern: '/^([0-9]{4})$' example: '1225' nullable: false Accounts: type: array items: type: object properties: accountId: type: string format: uuid description: The unique identifier given to an account. nullable: false linkType: type: string description: >- The type of link between the account and the card. example: Primary nullable: false InstitutionId: type: string format: uuid description: The unique identifier given to an institution. nullable: false PINSet: type: boolean description: >- A value indicating whether a PIN has been set on the card. nullable: false PINOffset: type: string description: >- The number of days from today when the PIN was last set. example: '30' nullable: true Status: type: string description: The status of the card. example: Active enum: - Active - Inactive - Closed - Frozen - Lost - Stolen - Pending nullable: false MaskedCard: type: string description: The masked card number. example: '****-****-****-1111' nullable: false relationshipPaging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer accountNumber: type: string nullable: true accountId: type: string nullable: true maskedCardNumber: type: string nullable: true cardId: type: string nullable: true paging: type: object properties: nextOffset: description: >- The next offset is the start position of the read pointer for pagination type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer x-jh: publishing: type: Integration stage: dev isPublic: true group: Digital Core name: Entity Services

Please ignore this field