Advanced profile (KYB)
The advanced profile is the application for identity and sanctions checks (KYC/KYB) that a company completes to make payments through Xtrm. Once the profile is approved and the company's identity verification level (IDL) is at 100%, which the API reports as AccountIdentityLevel Advanced, Xtrm unlocks funding for the company's account. Use these endpoints to submit the application for your own company or a company connected to yours, such as a client company you onboard as a managing platform (each identified by its SPN account number), track its status, and read back the submitted details. Reaching Advanced takes a complete Identity profile in the Xtrm web app, including the company's documents: a government-issued photo ID for its administrator and, for a private company, a company tax document that shows its tax ID, such as a W-9 for a US company. No API call uploads documents, so onboarding a company isn't API-only. The company uploads them from its own account, or, for a client company, your platform uploads them for it as a manager service. Complete the Identity profile first, then submit the advanced profile. See Complete the advanced profile.
The application covers business entity, authorized contact, and ownership information. The authorized contact is the company's director or signatory, and there's no separate director section. Which fields are required depends on whether the profile is international: every company registered outside the US has an international profile, and a US company chooses USA Only or International in Payments_Type. An international profile needs the business entity details with the company's industry and expected activity, the authorized contact, and the ownership information. A USA Only profile has a lighter onboarding: it needs the business entity details and IsPublicallyTraded. A company that isn't publicly traded lists each person who owns 26% or more of it.
The lookup endpoints at the end of this page return reference lists for profile fields: countries, regions, company types, NAICS industries, job titles, and identification types. Each lookup takes a POST request; a GET returns HTTP 404.
- POST
/API/v4/Register/CompanyAdvancedProfileSubmit a company advanced profile - POST
/API/v4/Register/CompanyAdvancedProfileStatusGet the status of an advanced profile - POST
/API/v4/Register/GetCompanyAdvancedProfileDetailsGet advanced profile details - POST
/API/v4/Register/GetAdvancedContactCountryList countries for an advanced profile - POST
/API/v4/Register/GetAdvancedContactStateList regions for an advanced profile - POST
/API/v4/Register/GetAdvancedContactCompanyTypeList company types for a country - POST
/API/v4/Register/GetNAICSList NAICS industry types - POST
/API/v4/Register/GetAdvancedContactJobTitlesList standard job titles - POST
/API/v4/Register/GetIdentificationTypeList identification types
#Submit a company advanced profile
/API/v4/Register/CompanyAdvancedProfileFills in and submits the advanced profile application for your company or a connected company. The application is for accounts that want to make payments.
The application has three sections: business entity information, authorized contact information, and ownership information.
- An international profile (every company registered outside the US, and a US company that sends
Payments_TypeInternational) needs the business entity details, includingIndustry_Classification,Purpose_Of_Transactionsand the expected activity, every field of the authorized contact, and the ownership information. - A USA Only profile (a US company that sends
Payments_TypeUSA Only) has a lighter onboarding: it needs the business entity details andIsPublicallyTraded. The authorized contact and the other international-only fields aren't required. - In either kind of profile, a company that isn't publicly traded sets
IsEligibleOwnershiptotrueand lists each person who owns 26% or more of it inOwners.
In the request, business entity details go in BusinessEntityInformation, the authorized contact in AuthorizedContactInformation, and owners in OwnerInformation.Owners. The authorized contact is the company's director or signatory, so the request has no director object: DirectorInformation was removed from the request and response in v4.9.
Before you submit, complete the company's Identity profile in the Xtrm web app, including its documents. No API call uploads documents, and in the web app the Advanced Services application opens only once the Identity profile is 100% complete. See Complete the advanced profile.
After you submit, call CompanyAdvancedProfileStatus to track the application and GetCompanyAdvancedProfileDetails to read back the submitted details.
Note
When IsPublicallyTraded is no, Owners lists one to three owners: each holds 26% or more, and together they can't own more than 100%.
Tip
The date-of-birth field is Date_Of_Birth in AuthorizedContactInformation but Date_of_Birth in Owners, and IsPublicallyTraded is spelled as shown. Copy these field names exactly.
Tip
The lookup endpoints on this page return reference lists for profile fields: GetAdvancedContactCountry, GetAdvancedContactState, GetAdvancedContactCompanyType, GetNAICS, GetAdvancedContactJobTitles, and GetIdentificationType.
Body parameters
AdvancedProfileobjectRequiredWrapper object for the request.
Child parameters1
requestobjectRequiredThe advanced profile application.
Child parameters7
AuthorizedContactInformationobjectOptionalThe authorized contact for the company: its director or signatory. There's no separate director section. Required in an international profile (every company registered outside the US, and a US company that sends
Payments_TypeInternational), where every field in this object is required. A USA Only profile, which has a lighter onboarding, doesn't need it.Child parameters12
Address_Line_1stringRequiredPrimary street address of the authorized contact.
Business_PhonestringRequiredThe authorized contact's business phone number, as digits only, with no spaces, dashes, brackets or
+. For a US number, send the 10 digits without the leading 1, e.g."2065551234". For a number outside the US, start with the country calling code, e.g."442071234567". Xtrm stores the value as you send it.CitizenshipstringRequiredTwo-character ISO country code of the authorized contact's primary citizenship.
CitystringRequiredCity of residence of the authorized contact.
Country_Code2stringRequiredTwo-character ISO 3166-1 alpha-2 country code for the authorized contact. For a company registered in the US, it must be
USin an international profile.Date_Of_BirthstringRequiredThe authorized contact's date of birth in
mm/dd/yyyyformat, e.g."10/10/1980".Email_AddressstringRequiredDirect professional email address of the authorized contact.
First_NamestringRequiredLegal first name of the authorized contact.
Job_TitlestringRequiredProfessional title or role of the authorized contact within the company, e.g.
Director.GetAdvancedContactJobTitleslists the standard job titles.Last_NamestringRequiredLegal last name of the authorized contact.
Postal_CodestringRequiredZIP or postal code of the authorized contact's address.
Region_Code2stringRequiredTwo-character state, province, or region abbreviation for the authorized contact, e.g.
CA.
BeneficiaryAccountNumberstringRequiredThe
SPNaccount number of the company whose advanced profile you're submitting: your own company or a company connected to yours.BusinessEntityInformationobjectRequiredInformation about the business entity. Required for all companies. In an international profile (every company registered outside the US, and a US company that sends
Payments_TypeInternational),Industry_Classification,Purpose_Of_Transactions,Expected_Currencies,Countries_Sending_ToandCountries_Receiving_Fromare also required. For a company registered in the US,Country_Of_Incorporation_Code2andCountry_Code2must beUS.Child parameters22
Address_Line_1stringRequiredPrimary street address of the business's headquarters.
Address_Line_2stringOptionalAdditional street address information (suite, floor) for the business.
Address_Line_3stringOptionalAdditional street address information for the business.
CitystringRequiredCity where the business's headquarters is located.
Company_TypestringRequiredLegal structure or corporate classification of the company, e.g.
C Corporation.GetAdvancedContactCompanyTypelists the standard company types for a country.Countries_Receiving_FromstringOptionalCountries the business expects to receive funds from, as a comma-separated string, e.g.
"US, GB". Required in an international profile (every company registered outside the US, and a US company that sendsPayments_TypeInternational).Countries_Sending_TostringOptionalCountries the business expects to make payments to, as a comma-separated string, e.g.
"US, GB". Required in an international profile (every company registered outside the US, and a US company that sendsPayments_TypeInternational).Country_Code2stringRequiredTwo-character ISO 3166-1 alpha-2 country code of the business's headquarters.
Country_Of_Incorporation_Code2stringRequiredTwo-character ISO country code where the business is officially incorporated.
Expected_Annual_VolumestringOptionalProjected total annual processing volume as a numeric string, e.g.
"500000.00". Optional; when you send it, it must be a number.Expected_CurrenciesstringOptionalCurrencies the business expects to transact in, as a comma-separated string, e.g.
"USD,CAD,GBP". Required in an international profile (every company registered outside the US, and a US company that sendsPayments_TypeInternational).Expected_Transaction_AmountstringOptionalProjected average amount per transaction as a numeric string, e.g.
"5000.00". Optional; when you send it, it must be a number.Fictitious_NamestringOptionalThe company's "doing business as" (DBA) or fictitious trade name.
Identification_NumberstringOptionalNumber of the authorized contact's government-issued identification document. Optional.
Identification_TypestringOptionalType of the authorized contact's government-issued identification document, e.g.
Passport. Optional.GetIdentificationTypelists the identification types.Industry_ClassificationstringOptionalGeneral category of the business, e.g.
Software Publishers. Required in an international profile (every company registered outside the US, and a US company that sendsPayments_TypeInternational); optional in a USA Only profile. Accepts any text, so the value doesn't have to match aGetNAICSindustry.Postal_CodestringRequiredZIP or postal code of the business's primary headquarters.
Purpose_Of_TransactionsstringOptionalThe nature of and reason for the business's transactions, e.g.
Business to Business Vendor Payments. Required in an international profile (every company registered outside the US, and a US company that sendsPayments_TypeInternational).Region_Code2stringRequiredTwo-character state or region code of the business's headquarters.
Region_Of_Incorporation_Code2stringRequiredTwo-character state or region abbreviation where the business is officially incorporated.
Tax_Identification_NumberstringRequiredOfficial tax identifier for the company, such as a US EIN, SSN, or international equivalent.
WebsitestringRequiredOfficial website URL or domain of the company.
Country_Of_Registration_Code2stringRequiredTwo-character ISO country code where the business is officially registered.
IssuerAccountNumberstringRequiredThe
SPNaccount number of the company whose API credentials you are using. If you use pseudo credentials, theSPNof the company you are acting on behalf of.OwnerInformationobjectRequiredOwnership information: whether the company is publicly traded, and its owners. Include it for every company, because it carries the required
IsPublicallyTraded. A company that isn't publicly traded setsIsEligibleOwnershiptotrueand lists each person who owns 26% or more of it inOwners.Child parameters4
IsEligibleOwnershipbooleanOptionalWhether one or more people own 26% or more of the company:
trueorfalse, as a JSON boolean. Sendtruewhen the company isn't publicly traded and has such owners, and list them inOwners. Xtrm readsOwnersonly when this istrue; it defaults tofalse.IsPublicallyTradedstringRequiredWhether the company is publicly traded:
yesorno, in any capitalization. For a publicly traded company, Xtrm doesn't keepOwners.Allowed values:
yes,no.Ownersobject[]OptionalThe people who own 26% or more of the company, one object per owner. Required when
IsEligibleOwnershipistrueandIsPublicallyTradedisno. Each owner holds 26% or more and together they can't own more than 100%, so the list has one to three owners. Xtrm ignores the list otherwise. In an international profile (every company registered outside the US, and a US company that sendsPayments_TypeInternational), every field of each owner is required exceptMiddle_NameandEmail_Address, andRegion_Code2andCountry_Code2must be exactly two characters.Child parameters13
Address_Line_1stringRequiredPrimary street address of the owner.
CitizenshipstringRequiredTwo-character ISO country code of the owner's primary citizenship.
CitystringRequiredCity of residence of the owner.
Country_Code2stringRequiredTwo-character ISO 3166-1 alpha-2 country code for the owner.
Date_of_BirthstringRequiredThe owner's date of birth in
mm/dd/yyyyformat, e.g."10/10/1980".Email_AddressstringOptionalEmail address of the owner. Optional.
First_NamestringRequiredLegal first name of the owner.
Job_TitlestringRequiredProfessional title or role of the owner, e.g.
Owner.Last_NamestringRequiredLegal last name of the owner.
Middle_NamestringOptionalLegal middle name of the owner.
Percentage_OwnedstringRequiredPercentage of the company this owner holds, as a whole number in a string from
"26"to"100", e.g."60"for 60%. In an international profile, Xtrm rejects a share of"25"or less.Postal_CodestringRequiredZIP or postal code of the owner's address.
Region_Code2stringRequiredTwo-character state, province, or region abbreviation for the owner.
Ticker_SymbolstringOptionalStock exchange ticker symbol for the company. Required in an international profile (every company registered outside the US, and a US company that sends
Payments_TypeInternational) whenIsPublicallyTradedisyes.
Payments_TypestringOptionalExpected geographical scope of payments:
USA OnlyorInternational, in any capitalization. Required for a company registered in the US (Country_Of_Registration_Code2US). For a company registered anywhere else, Xtrm sets it toInternational, whatever you send.Allowed values:
USA Only,International.
Response fields
AdvancedProfileResponseobjectWrapper object for the response.
Child parameters1
AdvancedProfileResultobjectResult of the submission.
Child parameters3
BeneficiaryIDstringThe
SPNaccount number of the company whose profile was updated.MessagestringConfirms the submission, e.g.
Advanced Profile Submitted Successfully. When the call fails, readOperationStatus.Errorsinstead.OperationStatusobjectOutcome of the operation.
Child parameters2
SuccessbooleanWhether the operation succeeded (
trueorfalse).Errorsstring[]Error messages when the call fails, as an array of strings. On success it's
nullor an empty array[], so decide withSuccess.
Related: Get the status of an advanced profile · Get advanced profile details · Create a business recipient · List business recipients · List countries for an advanced profile · List regions for an advanced profile · List company types for a country · List NAICS industry types · List standard job titles · List identification types
#Get the status of an advanced profile
/API/v4/Register/CompanyAdvancedProfileStatusReturns the status of the advanced profile application for your own company or a company connected to yours. The status is returned in Message and is one of Submitted, Pending, Approved, or Deactive. Submitted and Pending mean the application is still with Xtrm for review. Xtrm usually reviews a USA Only profile in 1 to 2 days and an international profile in 5 to 7 days, so poll on a schedule rather than in a tight loop. On Deactive, stop polling and contact [email protected].
If the company has no advanced profile on file, the call returns HTTP 400 with Please complete company advanced profile to view the status.
Body parameters
AdvancedProfileStatusobjectRequiredWrapper object for the request.
Child parameters1
requestobjectRequiredThe status query.
Child parameters2
IssuerAccountNumberstringRequiredThe
SPNaccount number of the company whose API credentials you are using. If you use pseudo credentials, theSPNof the company you are acting on behalf of.BeneficiaryAccountNumberstringRequiredThe
SPNaccount number of the company whose profile status you're checking.
Response fields
AdvancedProfileStatusResponseobjectWrapper object for the response.
Child parameters1
AdvancedProfileStatusResultobjectResult of the status query.
Child parameters3
BeneficiaryIDstringThe
SPNaccount number of the company whose profile status was queried.MessagestringThe current status of the advanced profile application:
Submitted,Pending,Approved, orDeactive.OperationStatusobjectOutcome of the operation.
Child parameters2
SuccessbooleanWhether the operation succeeded (
trueorfalse).Errorsstring[]Error messages when the call fails, as an array of strings. On success it's
nullor an empty array[], so decide withSuccess.
Related: Submit a company advanced profile · Get advanced profile details
#Get advanced profile details
/API/v4/Register/GetCompanyAdvancedProfileDetailsReturns the advanced profile application details for a company your account has read access to: your own company or a connected company.
The response uses the same sections as CompanyAdvancedProfile (BusinessEntityInformation, AuthorizedContactInformation, and OwnerInformation) and adds the application Status.
Note
Some response fields differ from the CompanyAdvancedProfile request: the response returns Expected_Per_Transaction_Amount (request: Expected_Transaction_Amount), and adds Legal_Company_Name, Job_Title_Other, and Status.
Body parameters
AdvancedProfileDetailsobjectRequiredWrapper object for the request.
Child parameters1
requestobjectRequiredThe details query.
Child parameters2
IssuerAccountNumberstringRequiredThe
SPNaccount number of the company whose API credentials you are using. If you use pseudo credentials, theSPNof the company you are acting on behalf of.BeneficiaryAccountNumberstringRequiredThe
SPNaccount number of the company whose profile you are querying.
Response fields
AdvancedProfileDetailsResponseobjectWrapper object for the response.
Child parameters1
AdvancedProfileDetailsResultobjectThe advanced profile details.
Child parameters8
BeneficiaryAccountNumberstringThe
SPNaccount number of the company.Country_Of_Registration_Code2stringTwo-character ISO country code where the business is officially registered.
Payments_TypestringExpected geographical scope of payments, e.g.
USA OnlyorInternational.StatusstringApproval status of the application:
Approved,Pending, or empty ornull. It can be empty even once Xtrm has approved the profile, so take the review status fromCompanyAdvancedProfileStatus.BusinessEntityInformationobjectInformation about the business entity.
Child parameters23
Legal_Company_NamestringLegal name of the company, from its Xtrm account.
Fictitious_NamestringThe company's "doing business as" (DBA) or fictitious trade name.
WebsitestringOfficial website URL or domain of the company.
Company_TypestringLegal structure or corporate classification of the company.
Industry_ClassificationstringGeneral category of the business.
Country_Of_Incorporation_Code2stringTwo-character ISO country code where the business is officially incorporated.
Region_Of_Incorporation_Code2stringTwo-character state or region abbreviation where the business is officially incorporated.
Tax_Identification_NumberstringOfficial tax identifier for the company, such as a US EIN, SSN, or international equivalent.
Identification_TypestringType of the authorized contact's government-issued identification document, e.g.
Passport.Identification_NumberstringNumber of the authorized contact's government-issued identification document.
Address_Line_1stringPrimary street address of the business's headquarters.
Address_Line_2stringAdditional street address information (suite, floor) for the business headquarters.
Address_Line_3stringAdditional street address information for the business headquarters.
CitystringCity where the business's headquarters is located.
Country_Code2stringTwo-character ISO 3166-1 alpha-2 country code of the business's headquarters.
Region_Code2stringTwo-character state or region abbreviation for the business's headquarters.
Postal_CodestringZIP or postal code of the business's primary headquarters.
Purpose_Of_TransactionsstringThe nature of and reason for the business's transactions.
Expected_CurrenciesstringCurrencies the business expects to transact in.
Expected_Annual_VolumestringProjected total annual processing volume as a numeric string.
Expected_Per_Transaction_AmountstringProjected average amount per transaction as a numeric string.
Countries_Sending_TostringCountries the business expects to make payments to.
Countries_Receiving_FromstringCountries the business expects to receive funds from.
AuthorizedContactInformationobjectThe authorized contact for the company.
Child parameters13
Job_TitlestringProfessional title or role of the authorized contact within the company.
Job_Title_OtherstringThe authorized contact's job title when
Job_TitleisOther. Empty in the examples.First_NamestringLegal first name of the authorized contact.
Last_NamestringLegal last name of the authorized contact.
Email_AddressstringDirect professional email address of the authorized contact.
Date_Of_BirthstringThe authorized contact's date of birth in
mm/dd/yyyyformat.CitizenshipstringTwo-character ISO country code of the authorized contact's primary citizenship.
Address_Line_1stringPrimary street address of the authorized contact.
CitystringCity of residence of the authorized contact.
Region_Code2stringTwo-character state, province, or region abbreviation for the authorized contact.
Country_Code2stringTwo-character ISO 3166-1 alpha-2 country code for the authorized contact.
Postal_CodestringZIP or postal code of the authorized contact's address.
Business_PhonestringThe authorized contact's business phone number, as submitted.
OwnerInformationobjectOwnership information.
Child parameters4
IsPublicallyTradedstringWhether the company is publicly traded:
yesorno, in any capitalization, e.g."No". Compare it without regard to case.IsEligibleOwnershipbooleanWhether one or more people own 26% or more of the company (
trueorfalse). When it'strue,Ownerslists them.Ticker_SymbolstringStock exchange ticker symbol for the company, if it is publicly traded, and an empty string otherwise.
Ownersobject[]The owners saved from the profile. Empty when none were saved, as for a publicly traded company or a submission with
IsEligibleOwnershipfalse.Child parameters13
Address_Line_1stringPrimary street address of the owner.
CitizenshipstringTwo-character ISO country code of the owner's primary citizenship.
CitystringCity of residence of the owner.
Country_Code2stringTwo-character ISO 3166-1 alpha-2 country code for the owner.
Date_of_BirthstringThe owner's date of birth in
mm/dd/yyyyformat.Email_AddressstringDirect email address of the owner.
First_NamestringLegal first name of the owner.
Job_TitlestringProfessional title or role of the owner.
Last_NamestringLegal last name of the owner.
Middle_NamestringLegal middle name of the owner.
Percentage_OwnedstringPercentage of the company this owner holds, as a whole number in a string, e.g.
"60".Postal_CodestringZIP or postal code of the owner's address.
Region_Code2stringTwo-character state, province, or region abbreviation for the owner.
OperationStatusobjectOutcome of the operation.
Child parameters2
SuccessbooleanWhether the operation succeeded (
trueorfalse).Errorsstring[]Error messages when the call fails, as an array of strings. On success it's
nullor an empty array[], so decide withSuccess.
Related: Submit a company advanced profile · Get the status of an advanced profile · Get the connection status of an account
#List countries for an advanced profile
/API/v4/Register/GetAdvancedContactCountryReturns the complete list of countries, each with its two-character ISO 3166-1 alpha-2 code (CountryCode) and name (CountryName). The advanced profile identifies countries by two-character codes, for example in Country_Code2, Citizenship, and Country_Of_Incorporation_Code2.
This list has a different shape from GetCountry. In GetCountry, CountryCode holds a three-character code, and the two-character code is in CountryISO2; each country also has an internal CountryID and a Currency. Use GetAdvancedContactCountry when you need two-character codes for the advanced profile or for GetAdvancedContactState. Use GetCountry when you need a CountryID, for example for GetState.
Important
Send a POST request with an empty JSON object {} as the body. A GET request returns HTTP 404 with {"StatusCode": 404, "Message": "The requested resource is not found"} and no OperationStatus.
Note
CountryCode means different things on different endpoints: here it is the two-character code (US), while in GetCountry it is the three-character code (USA).
Response fields
AdvancedContactCountryResponseobjectWrapper object for the response.
Child parameters1
AdvancedContactCountryResultobjectResult of the lookup.
Child parameters2
AdvancedContactCountryobjectThe country list.
Child parameters1
AdvancedContactCountryDetailsobject[]One entry per country.
Child parameters2
CountryCodestringTwo-character ISO country code (ISO 3166-1 alpha-2), e.g.
US.CountryNamestringFull registered name of the country.
OperationStatusobjectOutcome of the operation.
Child parameters2
SuccessbooleanWhether the operation succeeded (
trueorfalse).Errorsstring[]Error messages when the call fails, as an array of strings. On success it's
nullor an empty array[], so decide withSuccess.
Related: List regions for an advanced profile · List countries · List regions for a country ID · Submit a company advanced profile
#List regions for an advanced profile
/API/v4/Register/GetAdvancedContactStateReturns the administrative regions (states, provinces, territories, and so on) of a country. Pass the two-character ISO country code in CountryCode, for example a value returned by GetAdvancedContactCountry. Each region has a StateCode and a StateName.
This call differs from GetState, which takes the internal CountryID from GetCountry plus your IssuerAccountNumber and returns only StateName. Use GetAdvancedContactState when you work with two-character country codes, as in the advanced profile.
Important
The advanced profile's region fields take two-character region codes, such as CA, and an owner's Region_Code2 must be exactly two characters. Check each StateCode before you use it: in the example response it holds the full region name in capitals, such as ALABAMA.
Body parameters
AdvancedContactStateobjectRequiredWrapper object for the request.
Child parameters1
requestobjectRequiredThe lookup query.
Child parameters1
CountryCodestringRequiredTwo-character ISO country code (ISO 3166-1 alpha-2) of the country whose regions you want, e.g.
US.
Response fields
AdvancedContactStateResponseobjectWrapper object for the response.
Child parameters1
AdvancedContactStateResultobjectResult of the lookup.
Child parameters2
AdvancedContactStateobjectThe region list.
Child parameters1
AdvancedContactStateDetailsobject[]One entry per region.
Child parameters2
StateCodestringThe region's identifier. In the example it's the region's full name in capitals, such as
ALABAMA, the same asStateName, not the two-character code that the advanced profile's region fields take.StateNamestringThe region's full name, in capitals, for example
ALABAMA.
OperationStatusobjectOutcome of the operation.
Child parameters2
SuccessbooleanWhether the operation succeeded (
trueorfalse).Errorsstring[]Error messages when the call fails, as an array of strings. On success it's
nullor an empty array[], so decide withSuccess.
Related: List countries for an advanced profile · List regions for a country ID · List countries · Submit a company advanced profile
#List company types for a country
/API/v4/Register/GetAdvancedContactCompanyTypeReturns the standard company types (legal structures) recognized and available for a specific country, such as C Corporation or Partnership for the US. Pass the country's two-character ISO code in CountryISO2. The advanced profile records the company's legal structure in BusinessEntityInformation.Company_Type.
Note
Before v4.8, this endpoint was named GetCompanyType.
Body parameters
CompanyTypeobjectRequiredWrapper object for the request.
Child parameters1
requestobjectRequiredThe lookup query.
Child parameters1
CountryISO2stringRequiredTwo-character ISO country code of the country to retrieve company types for, e.g.
US.
Response fields
CompanyTypesResponseobjectWrapper object for the response.
Child parameters1
CompanyTypeResultobjectResult of the lookup.
Child parameters2
CompanyTypesobjectThe company type list.
Child parameters1
CompanyTypeDetailsobject[]One entry per company type.
Child parameters1
CompanyTypestringA recognized legal structure for companies in the requested country.
OperationStatusobjectOutcome of the operation.
Child parameters2
SuccessbooleanWhether the operation succeeded (
trueorfalse).Errorsstring[]Error messages when the call fails, as an array of strings. On success it's
nullor an empty array[], so decide withSuccess.
Related: List countries for an advanced profile · Submit a company advanced profile
#List NAICS industry types
/API/v4/Register/GetNAICSReturns the list of standard NAICS (North American Industry Classification System) industry types. The advanced profile records the business's industry category in BusinessEntityInformation.Industry_Classification.
Note
Send a POST request with an empty JSON object {} as the body.
Response fields
NAICSResponseobjectWrapper object for the response.
Child parameters1
NAICSResultobjectResult of the lookup.
Child parameters2
NAICSobjectThe industry list.
Child parameters1
NAICSDetailsobject[]One entry per industry type.
Child parameters1
IndustrystringGeneral classification of the business industry, e.g.
Accommodation.
OperationStatusobjectOutcome of the operation.
Child parameters2
SuccessbooleanWhether the operation succeeded (
trueorfalse).Errorsstring[]Error messages when the call fails, as an array of strings. On success it's
nullor an empty array[], so decide withSuccess.
Related: Submit a company advanced profile
#List standard job titles
/API/v4/Register/GetAdvancedContactJobTitlesReturns the list of standard job titles, such as CEO, Director, and Owner. The advanced profile records job titles in AuthorizedContactInformation.Job_Title and OwnerInformation.Owners[].Job_Title.
Note
Send a POST request with an empty JSON object {} as the body.
Response fields
JobTitlesResponseobjectWrapper object for the response.
Child parameters1
JobTitlesResultobjectResult of the lookup.
Child parameters2
JobTitlesobjectThe job title list.
Child parameters1
JobTitlesDetailsobject[]One entry per job title.
Child parameters1
JobTitlestringA standard job title or professional designation.
OperationStatusobjectOutcome of the operation.
Child parameters2
SuccessbooleanWhether the operation succeeded (
trueorfalse).Errorsstring[]Error messages when the call fails, as an array of strings. On success it's
nullor an empty array[], so decide withSuccess.
Related: Submit a company advanced profile
#List identification types
/API/v4/Register/GetIdentificationTypeReturns the identification types you can submit for account completion, such as Passport or DriversLicense. The advanced profile records the type of the authorized contact's identification document in BusinessEntityInformation.Identification_Type.
Note
Send a POST request with an empty JSON object {} as the body.
Response fields
IdentificationTypeResponseobjectWrapper object for the response.
Child parameters1
IdentificationTypeResultobjectResult of the lookup.
Child parameters2
IdentificationTypeobjectThe identification type list.
Child parameters1
IdentificationTypeDetailsobject[]One entry per identification type.
Child parameters1
IdentificationTypestringName of an identity document type, e.g.
Passport.
OperationStatusobjectOutcome of the operation.
Child parameters2
SuccessbooleanWhether the operation succeeded (
trueorfalse).Errorsstring[]Error messages when the call fails, as an array of strings. On success it's
nullor an empty array[], so decide withSuccess.
Related: Submit a company advanced profile