Show Menu

Company Advanced Profile

This API calls allows your to fill and submit your or your connected company's Advanced Profile. There are 4 sections in the advanced profile. Business Entity Informations, Authorized Contact Information, Director Information, Ownership Information. If you are completing this form for a US company, you have to complete Business Entity Information and Authorized Contact Information rest of the sections are not required. If you are completing this form for a non US company, you have to complete all the four sections (Business entity, Authorized contact, Director and Ownership information).

post/API/v4/Register/CompanyAdvancedProfile

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters for companys in US

IssuerAccountNumberstring

String length: inclusive between 1 and 25

FromAccountNumberstring

String length: inclusive between 1 and 25. Can be Issuer account number(SPNXXX) or Beneficiary company account number (SPNXXX)

Country_Of_Registration_Code2string

String length: 2. Use API/v4/Register/GetAdvancedContactCountry to get list of country.

Business Entity Information

Fictitious_NamestringFictitious Name/Doing Business As (DBA)

String length: inclusive between 1 and 255. Fictitious Name/Doing Business As (DBA)

Websitestring

String length: inclusive between 1 and 255.

Company_Typestring

String length: inclusive between 1 and 255. Use API/v4/Register/GetCompanyType to select from the list of company types.

Industry_Classificationstring

String length: inclusive between 1 and 255. Use API/v4/Register/GetNaics to select from the list of industry classification.

Date_Of_Registration

Region_Of_Incorporationstring

String length: inclusive between 1 and 255.

Country_Of_Registration_Code2string

String length: 2

Ticker_Symbolstring

String length: 1 and 2

Tax_Identification_Numberstring

String length: inclusive between 1 and 255.

Address_Line_1string

String length: inclusive between 1 and 255.

Address_Line_2string

String length: inclusive between 1 and 255.

Address_Line_3string

String length: inclusive between 1 and 255.

Citystring

String length: inclusive between 1 and 255.

Country_Code2string

String length: 2. Use API/v4/Register/GetAdvancedContactCountry to get list of country.

Region_Code2string

String length: 2. Use API/v4/Register/GetAdvancedContactState to get list of State/Region/County.

Postal_Codestring

String length: inclusive between 1 and 255.

Number_Of_Employeesint

Int length: 1 and 6

Expected_Monthly_Paymentsstring

Int length: 1 and 10.

Expected_Monthly_Volumestring

Int length: 1 and 10.

Purpose_Of_Paymentsstring

String length: inclusive between 1 and 255.

Countries_Sending_Payments_Tostring

String length: inclusive between 1 and 255.

Countries_Receiving_Payments_Fromstring

String length: inclusive between 1 and 255.

Authorized Contact Information

Job_Titlestring

String length: inclusive between 1 and 255. Use API/v4/Register/GetAdvancedContactJobTitles to get list of job titles.

First_Namestring

String length: inclusive between 1 and 255.

Middle_Namestring

String length: inclusive between 1 and 255.

Last_Namestring

String length: inclusive between 1 and 255.

Genderstring

String length: inclusive between 4 and 5.

Email_Addressstring

String length: inclusive between 1 and 200

Date_Of_BirthDate

Date: mm/dd/yyyy

Citizenshipstring

String length: inclusive between 1 and 255.

Identification_Typestring

String length: inclusive between 1 and 255. Use API/v4/Register/GetIdentificationType to get list of identification types.

Identification_Numberstring

String length: inclusive between 1 and 255.

Issue_DateDate

Date: mm/dd/yyyy

Expiration_DateDate

Date: mm/dd/yyyy

Issuing_Agencystring

String length: inclusive between 1 and 255.

Address_1string

String length: inclusive between 1 and 255.

Citystring

String length: inclusive between 1 and 255.

Region_Code2string

String length: 2. Use API/v4/Register/GetAdvancedContactState to get list of State/Region/County.

Country_Code2string

String length: 2. Use API/v4/Register/GetAdvancedContactCountry to get list of country.

Postal_Codestring

String length: inclusive between 1 and 255.

Business_Phonestring

SString length: inclusive between 1 and 255.

Reponse Parameters

Company Advanced Profile Responsestring

Returned if successful. Allowed parameters are
BeneficiaryID — Beneficiary Company or Issuer Account number for whom the advacened profile was completed.
Message — Advanced profile submission status

OperationStatusstring

Always returned Indicates the status of the operation. Allowed parameters are:
Errors - Displays an error message if the Property name Obligation Definition/value operation was unsuccessful. For more information, see API Error Message Appendix.
Success—Indicates whether the operation was successful. Returns True if the action was successful or False if it was not successful.

Request Parameters for companys Not in US

IssuerAccountNumberstring

String length: inclusive between 1 and 25

FromAccountNumberstring

String length: inclusive between 1 and 25. Can be Issuer account number(SPNXXX) or Beneficiary company account number (SPNXXX)

Country_Of_Registration_Code2string

String length: 2. String length: 2. Use API/v4/Register/GetAdvancedContactCountry to get list of country.

Business Entity Information

Fictitious_NamestringFictitious Name/Doing Business As (DBA)

String length: inclusive between 1 and 255. Fictitious Name/Doing Business As (DBA)

Websitestring

String length: inclusive between 1 and 255.

Company_Typestring

String length: inclusive between 1 and 255. Use API/v4/Register/GetCompanyType to select from the list of company types.

Industry_Classificationstring

String length: inclusive between 1 and 255. Use API/v4/Register/GetNaics to select from the list of industry classification.

Date_Of_Registrationdate

Date: mm/dd/yyyy

Region_Of_Incorporationstring

String length: inclusive between 1 and 255.

Ticker_Symbolstring

String length: 2

Tax_Identification_Numberstring

String length: inclusive between 1 and 255.

Address_Line_1string

String length: inclusive between 1 and 255.

Address_Line_2string

String length: inclusive between 1 and 255.

Address_Line_3string

String length: inclusive between 1 and 255.

Citystring

String length: inclusive between 1 and 255.

Country_Code2string

String length: 2. Use API/v4/Register/GetAdvancedContactCountry to get list of country.

Region_Code2string

String length: 2. Use API/v4/Register/GetAdvancedContactState to get list of State/Region/County.

Postal_Codestring

String length: inclusive between 1 and 255.

Number_Of_Employeesint

String length: inclusive between 1 and 6

Expected_Monthly_Paymentsint

String length: inclusive between 1 and 10

Expected_Monthly_Volumeint

String length: inclusive between 1 and 10

Purpose_Of_Paymentsstring

String length: inclusive between 1 and 255.

Countries_Sending_Payments_Tostring

String length: inclusive between 1 and 255.

Countries_Receiving_Payments_Fromstring

String length: inclusive between 1 and 255.

Authorized Contact Information

Job_Titlestring

String length: inclusive between 1 and 255. Use API/v4/Register/GetAdvancedContactJobTitles to get list of job titles.

First_Namestring

String length: inclusive between 1 and 255.

Middle_Namestring

String length: inclusive between 1 and 255.

Last_Namestring

String length: inclusive between 1 and 255.

Genderstring

String length: inclusive between 5 and 6

Email_Addressstring

String length: inclusive between 1 and 255.

Date_Of_Birthdate

Date: mm/dd/yyyy

Citizenshipstring

String length: inclusive between 1 and 255.

Identification_Typestring

String length: inclusive between 1 and 255. Use API/v4/Register/GetIdentificationType to get list of identification types.

Identification_Numberstring

String length: inclusive between 1 and 255.

Issue_Datedate

Date: mm/dd/yyyy

Expiration_Datedate

Date: mm/dd/yyyy

Issuing_Agencystring

String length: inclusive between 1 and 255.

Address_1string

String length: inclusive between 1 and 255.

Citystring

String length: inclusive between 1 and 255.

Region_Code2string

String length: 2. Use API/v4/Register/GetAdvancedContactState to get list of State/Region/County.

Country_Code2string

String length: 2. Use API/v4/Register/GetAdvancedContactCountry to get list of country.

Postal_Codestring

String length: inclusive between 1 and 255.

Business_Phonestring

String length: inclusive between 1 and 255.

Director Information: If you have more than one Director, repeat the entire section with array. You can add a maximum of 5 Directors.

Job_Titlestring

String length: inclusive between 1 and 255. Use API/v4/Register/GetAdvancedContactJobTitles to get list of job titles.

First_Namestring

String length: inclusive between 1 and 255.

Last_Namestring

String length: inclusive between 1 and 255.

Date_of_Birthstring

String length: inclusive between 1 and 255.

Nationalitystring

String length: inclusive between 1 and 255.

Identitification_Typestring

String length: inclusive between 1 and 255. Use API/v4/Register/GetIdentificationType to get list of identification types.

Identity_Document_Numberstring

String length: inclusive between 1 and 255.

Identity_Document_Expirationdate

Date: mm/dd/yyyy

Jurisdictionstring

String length: inclusive between 1 and 255.

Address_1string

String length: inclusive between 1 and 255.

Citystring

String length: inclusive between 1 and 255.

Country_Code2string

String length: 2. Use API/v4/Register/GetAdvancedContactCountry to get list of country.

Region_Code2string

String length: 2. Use API/v4/Register/GetAdvancedContactState to get list of State/Region/County.

Postal_Codestring

String length: inclusive between 1 and 255.

Ownership Information: If you have more than one Owner, repeat the entire section with array. You can add a maximum of 3 owners.

Is_the_Company_Pubicly_Tradedstring

String length: true/false

Percentage_Ownedstring

String length: inclusive between 1 and 255.

First_Namestring

String length: inclusive between 1 and 255.

Last_Namestring

String length: inclusive between 1 and 255.

Occupationstring

String length: inclusive between 1 and 255.

Source_of_Incomestring

String length: inclusive between 1 and 255.

Date_of_Birthdate

Date: mm/dd/yyyy

Nationalitystring

String length: inclusive between 1 and 255.

Identity_Document_Typestring

String length: inclusive between 1 and 255. Use API/v4/Register/GetIdentificationType to get list of identification types.

Identity_Document_Numberstring

String length: inclusive between 1 and 255.

Jurisdictionstring

String length: inclusive between 1 and 255.

Address_1string

String length: inclusive between 1 and 255.

Citystring

String length: inclusive between 1 and 255.

Country_Code2string

String length: 2. Use API/v4/Register/GetAdvancedContactCountry to get list of country..

Region_Code2string

String length: 2. Use API/v4/Register/GetAdvancedContactState to get list of State/Region/County.

Postal_Codestring

String length: inclusive between 1 and 255.

Reponse Parameters

Company Advanced Profile Responsestring

Returned if successful. Allowed parameters are
BeneficiaryID — Beneficiary Company or Issuer Account number for whom the advacened profile was completed.
Message — Advanced profile submission status

OperationStatusstring

Always returned Indicates the status of the operation. Allowed parameters are:
Errors - Displays an error message if the Property name Obligation Definition/value operation was unsuccessful. For more information, see API Error Message Appendix.
Success—Indicates whether the operation was successful. Returns True if the action was successful or False if it was not successful.

Sample Request:

sandbox.xapi.xtrm.com/API/v4/Register/CompanyAdvancedProfile 
                                                
{
  "AdvancedProfile":{
          "request":{
                   "issuerAccountNumber":"SPN Account Number",
                   "BeneficiaryAccountNumber":"Beneficiary SPN Account Number",
                   "Country_Of_Registration_Code2":"Use 'GetAdvancedContactCountry' to get Country",
                   "BusinessEntityInformation":
                        {
                         "Legal_Company_Name":"Legal Company Name",
                         "Fictitious_Name":"Fictitious Name",
                         "Website":"Website",
                         "Company_Type":"Company Type",
                         "Industry_Classification":"Use 'GetNAICS' to get NAICS",
                         "Date_Of_Registration":"Date Of Incorporation",
                         "Region_Of_Incorporation":"Subdivision Of Incorporation",
                         "Ticker_Symbol":"Ticker Symbol",
                         "Tax_Identification_Number":"Tax Identification Number",
                         "Address_Line_1":"Address Line 1",
                         "Address_Line_2":"Address Line 2",
                         "Address_Line_3":"Address Line 3",
                         "City":"City",
                         "Country_Code2":"Use 'GetAdvancedContactCountry' to get Country",
                         "Region_Code2":"Use 'GetAdvancedContactState' to get Region",
                         "Postal_Code":"Postal Code",
                         "Number_Of_Employees":"Number Of Employees",
                         "Expected_Monthly_Payments":"Expected Monthly Payments",
                         "Expected_Monthly_Volume":"Expected Monthly Volume",
                         "Purpose_Of_Payments":"Purpose Of Payments",
                         "Countries_Sending_Payments_To":"Countries Sending Payments To",
                         "Countries_Receiving_Payments_From":"Countries Receiving Payments From"
                         },
                          "AuthorizedContactInformation":{
                          "Job_Title":"Use 'GetAdvancedContactJobTitles' to get Job Title",
                          "First_Name":"First Name",
                          "Middle_Name":"Middle Name",
                          "Last_Name":"Last Name",
                          "Gender":"Gender",
                          "Email_Address":"Primary Email Address",
                          "Date_Of_Birth":"Date Of Birth",
                          "Citizenship":"Citizenship",
                          "Identification_Type":"Identification Type",
                          "Identification_Number":"Identification Number",
                          "Issue_Date":"Identification Issue Date",
                          "Expiration_Date":"Identification Expiration Date",
                          "Issuing_Agency":"Use 'GetCompanyType' to get Issuing Agency",
                          "Address_1":"Contact Address 1",
                          "City":"Identification City",
                          "Region_Code2":"Use 'GetAdvancedContactState' to get Region",
                          "Country_Code2":"Use 'GetAdvancedContactCountry' to get Country",
                          "Postal_Code":"Contact Zip",
                          "Business_Phone":"Contact Business Phone"
                          },
                            "DirectorInformation":{
                            "Directors":
                                        [
                                         {
                                          "Job_Title":"Job Title",
                                          "First_Name":"First Name",
                                          "Last_Name":"Last Name",
                                          "Date_of_Birth":"Date of Birth",
                                          "Nationality":"Use 'GetAdvancedContactCountry' to get Country",
                                          "Identification_Type":"Identity Document Type",
                                          "Identity_Document_Number":"Identity Document Number",
                                          "Identity_Document_Expiration":"Identity Document Expiration",
                                          "Jurisdiction":"Jurisdiction",
                                          "Address_1":"Address 1",
                                          "City":"City",
                                          "Country_Code2":"Use 'GetAdvancedContactCountry' to get Country",
                                          "Region_Code2":"Use 'GetAdvancedContactState' to get Region",
                                          "Postal_Code":"Postal Code"
                                            }
                                             ]
                                              },
                                                "OwnerInformation":{
                                                "IsPublicallyTraded":"yes",
                                                "Owners":
                                                  [
                                                   {
                                                    "Percentage_Owned":"Percentage Owned",
                                                    "First_Name":"First Name",
                                                    "Last_Name":"Last Name",
                                                    "Occupation":"Occupation",
                                                    "Source_of_Income":"Source of Income",
                                                    "Date_of_Birth":"Date of Birth",
                                                    "Nationality":"Nationality",
                                                    "Identity_Document_Type":"Identity Document Type",
                                                    "Identity_Document_Number":"Identity Document Number",
                                                    "Identity_Document_Expiration":"Identity Document Expiration",
                                                    "Jurisdiction":"Jurisdiction",
                                                    "Address_1":"Address 1",
                                                    "City":"City",
                                                    "Country_Code2":"Use 'GetAdvancedContactCountry' to get Country",
                                                    "Region_Code2":"Use 'GetAdvancedContactState' to get Region",
                                                    "Postal_Code":"Postal Code"
                                                       }
                                                        ]
                                                         }
                                                          }
                                                           }
                                                            }

Sample Response:


{
	"AdvancedProfileResponse": {
		"AdvancedProfileResult": {
			"BeneficiaryID": "SPN19134717",
			"Message": "Advanced Profile Submitted Successfully",
			"OperationStatus": {
				"Success": true,
				"Errors": null
			}
		}
	}
}

Why

Products

Developers

How It Works

Resources

Payment and foreign exchange transactions are powered and provided by Corpay. “Corpay” is the marketing trade name for the International Payment Solutions and Risk Management Solutions provided by certain subsidiaries of FleetCor Technologies, Inc. Use of this service is governed by Corpay’s Terms and Conditions.

➤