POST applications/{applicationUid}/UTMA/persons?giftState={giftState}

Request Information

URI Parameters

Name	Description	Type	Additional information
applicationUid		globally unique identifier	Required
giftState		string	Required

Body Parameters

PersonModel

Name	Type	Additional information
FirstName	string	None.
MiddleName	string	None.
LastName	string	None.
SuffixType	SuffixType	None.
PhoneNumber	PhoneModel	None.
PrimaryAddress	AddressModel	None.
MailingAddress	AddressModel	None.
IsUsCitizen	boolean	None.
SSN	string	None.
CountryIso3Code	string	None.
PassportNumber	string	None.
DateOfBirth	date	None.
IsSubjectToBackupWithholdings	boolean	None.
MaritalStatusType	MaritalStatusType	None.

Request Formats

application/json, text/json

Sample:

{
  "FirstName": "sample string 1",
  "MiddleName": "sample string 2",
  "LastName": "sample string 3",
  "SuffixType": 1,
  "PhoneNumber": {
    "Iso3CountryCode": "sample string 1",
    "AreaCode": "sample string 2",
    "LocalNumber": "sample string 3"
  },
  "PrimaryAddress": {
    "Street": "sample string 1",
    "AptOrSuite": "sample string 2",
    "City": "sample string 3",
    "CountryIso3Code": "sample string 4",
    "PostalCode": "sample string 5",
    "State": "sample string 6"
  },
  "MailingAddress": {
    "Street": "sample string 1",
    "AptOrSuite": "sample string 2",
    "City": "sample string 3",
    "CountryIso3Code": "sample string 4",
    "PostalCode": "sample string 5",
    "State": "sample string 6"
  },
  "IsUsCitizen": true,
  "SSN": "sample string 5",
  "CountryIso3Code": "sample string 6",
  "PassportNumber": "sample string 7",
  "DateOfBirth": "2023-06-03T13:25:00.5363362-04:00",
  "IsSubjectToBackupWithholdings": true,
  "MaritalStatusType": 1
}

application/xml, text/xml

Sample:

<PersonModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBI.WebAPI.RegistrationGateway.Business.Models.Registration.Persons">
  <CountryIso3Code>sample string 6</CountryIso3Code>
  <DateOfBirth>2023-06-03T13:25:00.5363362-04:00</DateOfBirth>
  <FirstName>sample string 1</FirstName>
  <IsSubjectToBackupWithholdings>true</IsSubjectToBackupWithholdings>
  <IsUsCitizen>true</IsUsCitizen>
  <LastName>sample string 3</LastName>
  <MailingAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/GBI.WebAPI.RegistrationGateway.Business.Models.Registration.Shared">
    <d2p1:AptOrSuite>sample string 2</d2p1:AptOrSuite>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:CountryIso3Code>sample string 4</d2p1:CountryIso3Code>
    <d2p1:PostalCode>sample string 5</d2p1:PostalCode>
    <d2p1:State>sample string 6</d2p1:State>
    <d2p1:Street>sample string 1</d2p1:Street>
  </MailingAddress>
  <MaritalStatusType>Single</MaritalStatusType>
  <MiddleName>sample string 2</MiddleName>
  <PassportNumber>sample string 7</PassportNumber>
  <PhoneNumber xmlns:d2p1="http://schemas.datacontract.org/2004/07/GBI.WebAPI.RegistrationGateway.Business.Models.Registration.Shared">
    <d2p1:AreaCode>sample string 2</d2p1:AreaCode>
    <d2p1:Iso3CountryCode>sample string 1</d2p1:Iso3CountryCode>
    <d2p1:LocalNumber>sample string 3</d2p1:LocalNumber>
  </PhoneNumber>
  <PrimaryAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/GBI.WebAPI.RegistrationGateway.Business.Models.Registration.Shared">
    <d2p1:AptOrSuite>sample string 2</d2p1:AptOrSuite>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:CountryIso3Code>sample string 4</d2p1:CountryIso3Code>
    <d2p1:PostalCode>sample string 5</d2p1:PostalCode>
    <d2p1:State>sample string 6</d2p1:State>
    <d2p1:Street>sample string 1</d2p1:Street>
  </PrimaryAddress>
  <SSN>sample string 5</SSN>
  <SuffixType>I</SuffixType>
</PersonModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Person

Name	Type	Additional information
PersonUid	globally unique identifier	None.
FirstName	string	None.
MiddleName	string	None.
LastName	string	None.
Suffix	SuffixType	None.
PrimaryPhoneNumber	Phone	None.
SecondaryPhoneNumber	Phone	None.
PrimaryAddress	Address	None.
MailingAddress	Address	None.
DateOfBirth	date	None.
IsUSCitizen	boolean	None.
SSN	string	None.
CountryIso3Code	string	None.
PassportNumber	string	None.
IsSubjectToBackupWithholdings	boolean	None.
MaritalStatusType	MaritalStatusType	None.

Response Formats

application/json, text/json

Sample:

{
  "PersonUid": "723a62e9-d328-48f1-a4b5-ce5c48e72390",
  "FirstName": "sample string 1",
  "MiddleName": "sample string 2",
  "LastName": "sample string 3",
  "Suffix": 1,
  "PrimaryPhoneNumber": {
    "Iso3CountryCode": "sample string 1",
    "AreaCode": "sample string 2",
    "LocalNumber": "sample string 3"
  },
  "SecondaryPhoneNumber": {
    "Iso3CountryCode": "sample string 1",
    "AreaCode": "sample string 2",
    "LocalNumber": "sample string 3"
  },
  "PrimaryAddress": {
    "AddressUid": "0b7ed236-5dea-4253-9ddd-6774b6af217c",
    "Street": "sample string 2",
    "AptOrSuite": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "CountryIso3Code": "sample string 6",
    "PostalCode": "sample string 7"
  },
  "MailingAddress": {
    "AddressUid": "0b7ed236-5dea-4253-9ddd-6774b6af217c",
    "Street": "sample string 2",
    "AptOrSuite": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "CountryIso3Code": "sample string 6",
    "PostalCode": "sample string 7"
  },
  "DateOfBirth": "2023-06-03T13:25:00.5363362-04:00",
  "IsUSCitizen": true,
  "SSN": "sample string 6",
  "CountryIso3Code": "sample string 7",
  "PassportNumber": "sample string 8",
  "IsSubjectToBackupWithholdings": true,
  "MaritalStatusType": 1
}

application/xml, text/xml

Sample:

<Person xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBI.WebAPI.RegistrationGateway.Business.Models.Registration">
  <CountryIso3Code>sample string 7</CountryIso3Code>
  <DateOfBirth>2023-06-03T13:25:00.5363362-04:00</DateOfBirth>
  <FirstName>sample string 1</FirstName>
  <IsSubjectToBackupWithholdings>true</IsSubjectToBackupWithholdings>
  <IsUSCitizen>true</IsUSCitizen>
  <LastName>sample string 3</LastName>
  <MailingAddress>
    <AddressUid>0b7ed236-5dea-4253-9ddd-6774b6af217c</AddressUid>
    <AptOrSuite>sample string 3</AptOrSuite>
    <City>sample string 4</City>
    <CountryIso3Code>sample string 6</CountryIso3Code>
    <PostalCode>sample string 7</PostalCode>
    <State>sample string 5</State>
    <Street>sample string 2</Street>
  </MailingAddress>
  <MaritalStatusType>Single</MaritalStatusType>
  <MiddleName>sample string 2</MiddleName>
  <PassportNumber>sample string 8</PassportNumber>
  <PersonUid>723a62e9-d328-48f1-a4b5-ce5c48e72390</PersonUid>
  <PrimaryAddress>
    <AddressUid>0b7ed236-5dea-4253-9ddd-6774b6af217c</AddressUid>
    <AptOrSuite>sample string 3</AptOrSuite>
    <City>sample string 4</City>
    <CountryIso3Code>sample string 6</CountryIso3Code>
    <PostalCode>sample string 7</PostalCode>
    <State>sample string 5</State>
    <Street>sample string 2</Street>
  </PrimaryAddress>
  <PrimaryPhoneNumber>
    <AreaCode>sample string 2</AreaCode>
    <Iso3CountryCode>sample string 1</Iso3CountryCode>
    <LocalNumber>sample string 3</LocalNumber>
  </PrimaryPhoneNumber>
  <SSN>sample string 6</SSN>
  <SecondaryPhoneNumber>
    <AreaCode>sample string 2</AreaCode>
    <Iso3CountryCode>sample string 1</Iso3CountryCode>
    <LocalNumber>sample string 3</LocalNumber>
  </SecondaryPhoneNumber>
  <Suffix>I</Suffix>
</Person>