PUT applications/{applicationUid}/persons/{personUid}

Request Information

URI Parameters

Name	Description	Type	Additional information
applicationUid		globally unique identifier	Required
personUid		globally unique identifier	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:05:01.0613525-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:05:01.0613525-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

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.