POST applications/{applicationUid}/legalEntities

Request Information

URI Parameters

NameDescriptionTypeAdditional information
applicationUid

globally unique identifier

Required

Body Parameters

CorporateLegalEntityModel
NameDescriptionTypeAdditional information
Name

string

None.

CountryIso3Code

string

None.

SSNorTIN

string

None.

PhoneNumber

PhoneModel

None.

LegalAddress

AddressModel

None.

MailingAddress

AddressModel

None.

IsSubjectToBackupWithholdings

boolean

None.

TaxForms

Collection of TaxFormType

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "CountryIso3Code": "sample string 2",
  "SSNorTIN": "sample string 3",
  "PhoneNumber": {
    "Iso3CountryCode": "sample string 1",
    "AreaCode": "sample string 2",
    "LocalNumber": "sample string 3"
  },
  "LegalAddress": {
    "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"
  },
  "IsSubjectToBackupWithholdings": true,
  "TaxForms": [
    1,
    1
  ]
}

application/xml, text/xml

Sample:
<CorporateLegalEntityModel 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 2</CountryIso3Code>
  <IsSubjectToBackupWithholdings>true</IsSubjectToBackupWithholdings>
  <LegalAddress 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>
  </LegalAddress>
  <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>
  <Name>sample string 1</Name>
  <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>
  <SSNorTIN>sample string 3</SSNorTIN>
  <TaxForms xmlns:d2p1="http://schemas.datacontract.org/2004/07/GBI.WebAPI.RegistrationGateway.Common.Enums">
    <d2p1:TaxFormType>W9</d2p1:TaxFormType>
    <d2p1:TaxFormType>W9</d2p1:TaxFormType>
  </TaxForms>
</CorporateLegalEntityModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CorporateLegalEntity
NameDescriptionTypeAdditional information
CorporateLegalEntityUid

globally unique identifier

None.

Name

string

None.

CountryIso3Code

string

None.

SSNorTIN

string

None.

PhoneNumber

Phone

None.

LegalAddress

Address

None.

MailingAddress

Address

None.

IsSubjectToBackupWithholdings

boolean

None.

TaxForms

Collection of TaxFormType

None.

Response Formats

application/json, text/json

Sample:
{
  "CorporateLegalEntityUid": "fd638705-735e-4c5d-adcc-8be7f2fc756a",
  "Name": "sample string 2",
  "CountryIso3Code": "sample string 3",
  "SSNorTIN": "sample string 4",
  "PhoneNumber": {
    "Iso3CountryCode": "sample string 1",
    "AreaCode": "sample string 2",
    "LocalNumber": "sample string 3"
  },
  "LegalAddress": {
    "AddressUid": "58224369-32ef-4dfb-97e0-fabf2306597e",
    "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": "58224369-32ef-4dfb-97e0-fabf2306597e",
    "Street": "sample string 2",
    "AptOrSuite": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "CountryIso3Code": "sample string 6",
    "PostalCode": "sample string 7"
  },
  "IsSubjectToBackupWithholdings": true,
  "TaxForms": [
    1,
    1
  ]
}

application/xml, text/xml

Sample:
<CorporateLegalEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBI.WebAPI.RegistrationGateway.Business.Models.Registration">
  <CorporateLegalEntityUid>fd638705-735e-4c5d-adcc-8be7f2fc756a</CorporateLegalEntityUid>
  <CountryIso3Code>sample string 3</CountryIso3Code>
  <IsSubjectToBackupWithholdings>true</IsSubjectToBackupWithholdings>
  <LegalAddress>
    <AddressUid>58224369-32ef-4dfb-97e0-fabf2306597e</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>
  </LegalAddress>
  <MailingAddress>
    <AddressUid>58224369-32ef-4dfb-97e0-fabf2306597e</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>
  <Name>sample string 2</Name>
  <PhoneNumber>
    <AreaCode>sample string 2</AreaCode>
    <Iso3CountryCode>sample string 1</Iso3CountryCode>
    <LocalNumber>sample string 3</LocalNumber>
  </PhoneNumber>
  <SSNorTIN>sample string 4</SSNorTIN>
  <TaxForms xmlns:d2p1="http://schemas.datacontract.org/2004/07/GBI.WebAPI.RegistrationGateway.Common.Enums">
    <d2p1:TaxFormType>W9</d2p1:TaxFormType>
    <d2p1:TaxFormType>W9</d2p1:TaxFormType>
  </TaxForms>
</CorporateLegalEntity>