Create a set of deposit account owner data

post

/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}/child/DepositAccountOwner

Request

Path Parameters
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Public Unique ID
    Maximum Length: 480
    The unique alphanumeric identifier of the deposit account owner record.
  • Title: Address Line 1
    Maximum Length: 240
    First address line of the owner address assigned to the deposit account.
  • Title: Address Line 2
    Maximum Length: 240
    Second address line of the owner address assigned to the deposit account.
  • Title: Address Line 3
    Maximum Length: 240
    Third address line of the owner address assigned to the deposit account.
  • Title: Address Line 4
    Maximum Length: 240
    Fourth address line of the owner address assigned to the deposit account.
  • Title: City
    Maximum Length: 60
    City of the owner address assigned to the deposit account.
  • Title: Comments
    Maximum Length: 480
    Comments provided by user for change of ownership.
  • Title: Country
    Maximum Length: 3
    Country of the owner address assigned to the deposit account.
  • Title: County
    Maximum Length: 60
    County of the owner address assigned to the deposit account.
  • The unique system generated numeric identifier of the deposit account.
  • Maximum Length: 30
    The unique agency-defined alphanumeric identifier of the deposit account.
  • Maximum Length: 480
    The unique alphanumeric identifier of the deposit account record.
  • Title: Ownership Key
    The unique system-generated numeric identifier of an owner assigned to a deposit account.
  • Title: Email Address
    Maximum Length: 320
    Email identifier of the owner assigned to the deposit account.
  • Title: First Name
    Maximum Length: 150
    First name of the person assigned as owner to the deposit account.
  • Title: Inactive Reason Code
    Maximum Length: 30
    Reason code provided by user for change of ownership.
  • Title: Last Name
    Maximum Length: 150
    Last name of the person assigned as owner to the deposit account.
  • Title: License Holder Name
    Maximum Length: 360
    Name on the license provided to establish a deposit account.
  • Title: License Number
    Maximum Length: 30
    The number of the license provided to establish a deposit account.
  • Title: License Type
    Maximum Length: 30
    The type of the license provided to establish a deposit account.
  • Title: Middle Name
    Maximum Length: 60
    Middle name of the person assigned as owner to the deposit account.
  • Title: Name
    Maximum Length: 360
    Name of the person or business assigned as owner to the deposit account.
  • Title: Owner Party ID
    Identifier of the party assigned as owner to the deposit account.
  • Title: Account Owner Type
    Maximum Length: 30
    Identifies the type of the party assigned as owner to the deposit account.
  • Title: Phone Area Code
    Maximum Length: 10
    Phone area code of the owner assigned to the deposit account.
  • Title: Phone Country Code
    Maximum Length: 10
    Phone country code of the owner assigned to the deposit account.
  • Title: Phone Extension
    Maximum Length: 20
    Phone extension code of the owner assigned to the deposit account.
  • Title: Phone Number
    Maximum Length: 40
    Phone number of the owner assigned to the deposit account.
  • Title: Postal Code
    Maximum Length: 60
    Postal code of the owner address assigned to the deposit account.
  • Title: Postal Plus4 Code
    Maximum Length: 10
    Extended postal code of the owner address assigned to the deposit account.
  • Title: Primary Owner
    Maximum Length: 1
    Identifies whether the owner is the primary owner or not.
  • Title: Province
    Maximum Length: 60
    Province of the owner address assigned to the deposit account.
  • Title: State
    Maximum Length: 60
    State of the owner address assigned to the deposit account.
  • Title: Valid From
    Identifies the start date of the ownership record.
  • Title: Valid To
    Identifies the end date of the ownership record.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : publicSectorDepositAccounts-DepositAccountOwner-item-response
Type: object
Show Source
  • Title: Public Unique ID
    Maximum Length: 480
    The unique alphanumeric identifier of the deposit account owner record.
  • Title: Address Line 1
    Maximum Length: 240
    First address line of the owner address assigned to the deposit account.
  • Title: Address Line 2
    Maximum Length: 240
    Second address line of the owner address assigned to the deposit account.
  • Title: Address Line 3
    Maximum Length: 240
    Third address line of the owner address assigned to the deposit account.
  • Title: Address Line 4
    Maximum Length: 240
    Fourth address line of the owner address assigned to the deposit account.
  • Title: City
    Maximum Length: 60
    City of the owner address assigned to the deposit account.
  • Title: Comments
    Maximum Length: 480
    Comments provided by user for change of ownership.
  • Title: Country
    Maximum Length: 3
    Country of the owner address assigned to the deposit account.
  • Title: County
    Maximum Length: 60
    County of the owner address assigned to the deposit account.
  • The unique system generated numeric identifier of the deposit account.
  • Maximum Length: 30
    The unique agency-defined alphanumeric identifier of the deposit account.
  • Maximum Length: 480
    The unique alphanumeric identifier of the deposit account record.
  • Title: Ownership Key
    The unique system-generated numeric identifier of an owner assigned to a deposit account.
  • Title: Email Address
    Maximum Length: 320
    Email identifier of the owner assigned to the deposit account.
  • Title: First Name
    Maximum Length: 150
    First name of the person assigned as owner to the deposit account.
  • Title: Inactive Reason Code
    Maximum Length: 30
    Reason code provided by user for change of ownership.
  • Title: Last Name
    Maximum Length: 150
    Last name of the person assigned as owner to the deposit account.
  • Title: License Holder Name
    Maximum Length: 360
    Name on the license provided to establish a deposit account.
  • Title: License Number
    Maximum Length: 30
    The number of the license provided to establish a deposit account.
  • Title: License Type
    Maximum Length: 30
    The type of the license provided to establish a deposit account.
  • Links
  • Title: Middle Name
    Maximum Length: 60
    Middle name of the person assigned as owner to the deposit account.
  • Title: Migrated Data
    Read Only: true
    Maximum Length: 3
    Default Value: N
    Identifies whether the ownership record is migrated or not.
  • Title: Name
    Maximum Length: 360
    Name of the person or business assigned as owner to the deposit account.
  • Title: Owner Party ID
    Identifier of the party assigned as owner to the deposit account.
  • Title: Account Owner Type
    Maximum Length: 30
    Identifies the type of the party assigned as owner to the deposit account.
  • Title: Phone Area Code
    Maximum Length: 10
    Phone area code of the owner assigned to the deposit account.
  • Title: Phone Country Code
    Maximum Length: 10
    Phone country code of the owner assigned to the deposit account.
  • Title: Phone Extension
    Maximum Length: 20
    Phone extension code of the owner assigned to the deposit account.
  • Title: Phone Number
    Maximum Length: 40
    Phone number of the owner assigned to the deposit account.
  • Title: Postal Code
    Maximum Length: 60
    Postal code of the owner address assigned to the deposit account.
  • Title: Postal Plus4 Code
    Maximum Length: 10
    Extended postal code of the owner address assigned to the deposit account.
  • Title: Primary Owner
    Maximum Length: 1
    Identifies whether the owner is the primary owner or not.
  • Title: Province
    Maximum Length: 60
    Province of the owner address assigned to the deposit account.
  • Title: State
    Maximum Length: 60
    State of the owner address assigned to the deposit account.
  • Title: Valid From
    Identifies the start date of the ownership record.
  • Title: Valid To
    Identifies the end date of the ownership record.
Back to Top