Retrieve Legal Entity

Return to the list of PayFac API examples

If you need to retrieve the latest information on file related to a Legal Entity for verification purposes or to check the status of cases requiring manual intervention, you must perform a GET operation specifying the legalEntityId. In the case of a retrieval request, the system does not require an accompanying XML message.

The final results for the manual review of Legal entity information will be available within 2 business days of the initial response to the create request.

Resource Information

GET parameters

Retrieve Legal Entity Response

The legalEntityRetrieveResponse message has the following format:

<legalEntityRetrievalResponse>
     <legalEntityName>Name of Legal Entity</legalEntityName>
     <legalEntityType>Type of Legal Entity</legalEntityType>
     <doingBusinessAs>Alternate Name</doingBusinessAs>
     <taxId>Tax Id/EIN</taxId>
     <contactPhone>Legal Entity Contact Number</contactPhone>
     <annualCreditCardSalesVolume>Annual Visa Sales</annualCreditCardSalesVolume>
     <hasAcceptedCreditCards>true or false</hasAcceptedCrreditCards>
     <address>
     <principal>
     <yearsInBusiness>Number of Years in Business</yearsInBusiness>
     <legalEntityId>12345678901234567</legalEntityId>
     <responseCode>3-digit Code</responseCode>
     <responseDescription>Description of Response Code</responseDescription>
     <backgroundCheckResults>
     <transactionId>1234567890123456789</transactionId>
     <updateDate>YYYY-MM-DDTHH:MM:SS+/-HH:MM</updateDate>
     <decisionDate>YYYY-MM-DDTHH:MM:SS+/-HH:MM</decisionDate>
     <tinValidationStatus>Pending</tinValidationStatus>
</legalEntityRetrievalResponse>

Example: Legal Entity Retrieval Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
     <legalEntityRetrievalResponse xmlns="http://psp.litle.com/api/merchant/onboard">
          <legalEntityName>Legal Entity Name</legalEntityName>
          <legalEntityType>CORPORATION</legalEntityType>
          <doingBusinessAs>Alternate Name</doingBusinessAs>
          <taxId>X-2345</taxId>
          <contactPhone>7817659800</contactPhone>
          <annualCreditCardSalesVolume>80</annualCreditCardSalesVolume>
          <hasAcceptedCreditCards>true</hasAcceptedCreditCards>
          <address>
               <streetAddress1>12 Norton St</streetAddress1>
               <city>City</city>
               <stateProvince>NH</stateProvince>
               <postalCode>03064</postalCode>
               <countryCode>USA</countryCode>
          </address>
          <principal>
               <principalId>1</principalId>
               <title>CEO</title>
               <firstName>p first</firstName>
               <lastName>p last</lastName>
               <emailAddress>emailAddress</emailAddress>
               <ssn>XXXXX-9876</ssn>
               <contactPhone>7817659800</contactPhone>
               <dateOfBirth>1980-10-12</dateOfBirth>
               <driversLicense>XXXXXXXX-9832</driversLicense>
               <driversLicenseState>MA</driversLicenseState>
               <address>
                    <streetAddress1>p street address 1</streetAddress1>
                    <streetAddress2>p street address 2</streetAddress2>
                    <city>Boston</city>
                    <stateProvince>MA</stateProvince>
                    <postalCode>01890</postalCode>
                    <countryCode>USA</countryCode>
               </address>
          </principal>
          <yearsInBusiness>USA</yearsInBusiness>
          <legalEntityId>3</legalEntityId>
          <responseCode>10</responseCode>
          <responseDescription>Approved</responseDescription>
          <backgroundCheckResults>
               <business>
                    <verificationResults>
                         <overallScores>
                              <score>Overall results for Business</score>
                              <description>Text Description of Score</description>
                         </overallScores>
                         <nameAddressTaxIdAssociation>
                              <code>Name_Address_TIN_info</code>
                              <description>Text Description of Code</description>
                         </nameAddressTaxIdAssociation>
                         <nameAddressPhoneAssociation>
                              <code>Name_Address_Phone_info</code>
                              <description>Text Description of Code</description>
                         </nameAddressPhoneAssociation>
                         <verificationIndicators>
                              <nameVerified>true or false</nameVerified>
                              <addressVerified>true or false</addressVerified>
                              <cityVerified>true or false</cityVerified>
                              <zipVerified>true or false</zipVerified>
                              <phoneVerified>true or false</phoneVerified>
                              <taxIdVerified>true or false</taxIdVerified>
                         </verificationIndicators>
                         <riskIndicators>
                              <riskIndicator>
                                   <code>Risk Indicator Info</code>
                                   <description>Text Description of Code</description>
                              </riskIndicator>
                         </riskIndicators>
                    </verificationResults>
               </business>
               <principal>
                    <verificationResults>
                         <overallScores>
                              <score>Overall Results for Principal</score>
                              <description>Text Description of Score</description>
                         </overallScores>
                         <nameAddressSsnAssociation>
                              <code>Name_Address_SSN_info</code>
                              <description>Text Description of Code</description>
                         </nameAddressSsnAssociation>
                         <nameAddressPhoneAssociation>
                                <code>Name_Address_Phone_info</code>
                                <description>Text Description of Code</description>
                         </nameAddressPhoneAssociation>
                         <verificationIndicators>
                              <nameVerified>true or false</nameVerified>
                              <addressVerified>true or false</addressVerified>
                              <phoneVerified>true or false</phoneVerified>
                              <ssnVerified>true or false</ssnVerified>
                              <dobVerified>true or false</dobVerified>
                         </verificationIndicators>
                         <riskIndicators>
                              <riskIndicator>
                                   <code>Risk Indicator results</code>
                                   <description>Text Description of Code</description>
                              </riskIndicator>
                         </riskIndicators>
                    </verificationResults>
               </principal>
               <businessToPrincipalAssociation>
                    <score>Business_To_Principal_info</score>
                    <description>Text Description of Score</description>
               </businessToPrincipalAssociation>
               <backgroundCheckDecisionNotes>Additional Info About Decision</backgroundCheckDecisionNotes>
               <bankruptcyData>
                    <bankruptcyType>Sub-category of bankruptcy</bankruptcyType>
                    <bankruptcyCount>1</bankruptcyCount>
                    <companyName>Company Name</companyName>
                    <streetAddress1>100 Main Street</streetAddress1>
                    <streetAddress2>Suite 2</streetAddress2>
                    <city>Boston</city>
                    <state>MA</state>
                    <zip>01150</zip>
                    <zip4>2202</zip4>
                    <filingDate>2011-05-13</filingDate>
               </bankruptcyData>
               <lienResult>
                    <lienyType>Subtype of Lien</lienyType>
                    <releasedCount>2</releasedCount>
                    <unreleasedCount>1</unreleasedCount>
                    <companyName>Company Name</companyName>
                    <streetAddress1>100 Main Street</streetAddress1>
                    <streetAddress2>Suite 2</streetAddress2>
                    <city>Boston</city>
                    <state>MA</state>
                    <zip>01150</zip>
                    <zip4>2202</zip4>
                    <filingDate>2011-05-13</filingDate>
               </lienResult>
          </backgroundCheckResults>
          <transactionId>82820200338801030</transactionId>
           <tinValidationStatus>Status of TIN Validation</tinValidationStatus>
     </legalEntityRetrievalResponse>

See Status Codes and Error Messages

Next: Create legal entity

Return to the list of PayFac API examples