API reference

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.

#Submit a company advanced profile

POST/API/v4/Register/CompanyAdvancedProfile

Fills 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_Type International) needs the business entity details, including Industry_Classification, Purpose_Of_Transactions and the expected activity, every field of the authorized contact, and the ownership information.
  • A USA Only profile (a US company that sends Payments_Type USA Only) has a lighter onboarding: it needs the business entity details and IsPublicallyTraded. 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 IsEligibleOwnership to true and lists each person who owns 26% or more of it in Owners.

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

  • AdvancedProfileobjectRequired

    Wrapper object for the request.

    Child parameters1
    • requestobjectRequired

      The advanced profile application.

      Child parameters7
      • AuthorizedContactInformationobjectOptional

        The 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_Type International), 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_1stringRequired

          Primary street address of the authorized contact.

        • Business_PhonestringRequired

          The 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.

        • CitizenshipstringRequired

          Two-character ISO country code of the authorized contact's primary citizenship.

        • CitystringRequired

          City of residence of the authorized contact.

        • Country_Code2stringRequired

          Two-character ISO 3166-1 alpha-2 country code for the authorized contact. For a company registered in the US, it must be US in an international profile.

        • Date_Of_BirthstringRequired

          The authorized contact's date of birth in mm/dd/yyyy format, e.g. "10/10/1980".

        • Email_AddressstringRequired

          Direct professional email address of the authorized contact.

        • First_NamestringRequired

          Legal first name of the authorized contact.

        • Job_TitlestringRequired

          Professional title or role of the authorized contact within the company, e.g. Director. GetAdvancedContactJobTitles lists the standard job titles.

        • Last_NamestringRequired

          Legal last name of the authorized contact.

        • Postal_CodestringRequired

          ZIP or postal code of the authorized contact's address.

        • Region_Code2stringRequired

          Two-character state, province, or region abbreviation for the authorized contact, e.g. CA.

      • BeneficiaryAccountNumberstringRequired

        The SPN account number of the company whose advanced profile you're submitting: your own company or a company connected to yours.

      • BusinessEntityInformationobjectRequired

        Information 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_Type International), Industry_Classification, Purpose_Of_Transactions, Expected_Currencies, Countries_Sending_To and Countries_Receiving_From are also required. For a company registered in the US, Country_Of_Incorporation_Code2 and Country_Code2 must be US.

        Child parameters22
        • Address_Line_1stringRequired

          Primary street address of the business's headquarters.

        • Address_Line_2stringOptional

          Additional street address information (suite, floor) for the business.

        • Address_Line_3stringOptional

          Additional street address information for the business.

        • CitystringRequired

          City where the business's headquarters is located.

        • Company_TypestringRequired

          Legal structure or corporate classification of the company, e.g. C Corporation. GetAdvancedContactCompanyType lists the standard company types for a country.

        • Countries_Receiving_FromstringOptional

          Countries 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 sends Payments_Type International).

        • Countries_Sending_TostringOptional

          Countries 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 sends Payments_Type International).

        • Country_Code2stringRequired

          Two-character ISO 3166-1 alpha-2 country code of the business's headquarters.

        • Country_Of_Incorporation_Code2stringRequired

          Two-character ISO country code where the business is officially incorporated.

        • Expected_Annual_VolumestringOptional

          Projected total annual processing volume as a numeric string, e.g. "500000.00". Optional; when you send it, it must be a number.

        • Expected_CurrenciesstringOptional

          Currencies 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 sends Payments_Type International).

        • Expected_Transaction_AmountstringOptional

          Projected average amount per transaction as a numeric string, e.g. "5000.00". Optional; when you send it, it must be a number.

        • Fictitious_NamestringOptional

          The company's "doing business as" (DBA) or fictitious trade name.

        • Identification_NumberstringOptional

          Number of the authorized contact's government-issued identification document. Optional.

        • Identification_TypestringOptional

          Type of the authorized contact's government-issued identification document, e.g. Passport. Optional. GetIdentificationType lists the identification types.

        • Industry_ClassificationstringOptional

          General category of the business, e.g. Software Publishers. Required in an international profile (every company registered outside the US, and a US company that sends Payments_Type International); optional in a USA Only profile. Accepts any text, so the value doesn't have to match a GetNAICS industry.

        • Postal_CodestringRequired

          ZIP or postal code of the business's primary headquarters.

        • Purpose_Of_TransactionsstringOptional

          The 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 sends Payments_Type International).

        • Region_Code2stringRequired

          Two-character state or region code of the business's headquarters.

        • Region_Of_Incorporation_Code2stringRequired

          Two-character state or region abbreviation where the business is officially incorporated.

        • Tax_Identification_NumberstringRequired

          Official tax identifier for the company, such as a US EIN, SSN, or international equivalent.

        • WebsitestringRequired

          Official website URL or domain of the company.

      • Country_Of_Registration_Code2stringRequired

        Two-character ISO country code where the business is officially registered.

      • IssuerAccountNumberstringRequired

        The SPN account number of the company whose API credentials you are using. If you use pseudo credentials, the SPN of the company you are acting on behalf of.

      • OwnerInformationobjectRequired

        Ownership 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 sets IsEligibleOwnership to true and lists each person who owns 26% or more of it in Owners.

        Child parameters4
        • IsEligibleOwnershipbooleanOptional

          Whether one or more people own 26% or more of the company: true or false, as a JSON boolean. Send true when the company isn't publicly traded and has such owners, and list them in Owners. Xtrm reads Owners only when this is true; it defaults to false.

        • IsPublicallyTradedstringRequired

          Whether the company is publicly traded: yes or no, in any capitalization. For a publicly traded company, Xtrm doesn't keep Owners.

          Allowed values: yes, no.

        • Ownersobject[]Optional

          The people who own 26% or more of the company, one object per owner. Required when IsEligibleOwnership is true and IsPublicallyTraded is no. 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 sends Payments_Type International), every field of each owner is required except Middle_Name and Email_Address, and Region_Code2 and Country_Code2 must be exactly two characters.

          Child parameters13
          • Address_Line_1stringRequired

            Primary street address of the owner.

          • CitizenshipstringRequired

            Two-character ISO country code of the owner's primary citizenship.

          • CitystringRequired

            City of residence of the owner.

          • Country_Code2stringRequired

            Two-character ISO 3166-1 alpha-2 country code for the owner.

          • Date_of_BirthstringRequired

            The owner's date of birth in mm/dd/yyyy format, e.g. "10/10/1980".

          • Email_AddressstringOptional

            Email address of the owner. Optional.

          • First_NamestringRequired

            Legal first name of the owner.

          • Job_TitlestringRequired

            Professional title or role of the owner, e.g. Owner.

          • Last_NamestringRequired

            Legal last name of the owner.

          • Middle_NamestringOptional

            Legal middle name of the owner.

          • Percentage_OwnedstringRequired

            Percentage 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_CodestringRequired

            ZIP or postal code of the owner's address.

          • Region_Code2stringRequired

            Two-character state, province, or region abbreviation for the owner.

        • Ticker_SymbolstringOptional

          Stock exchange ticker symbol for the company. Required in an international profile (every company registered outside the US, and a US company that sends Payments_Type International) when IsPublicallyTraded is yes.

      • Payments_TypestringOptional

        Expected geographical scope of payments: USA Only or International, in any capitalization. Required for a company registered in the US (Country_Of_Registration_Code2 US). For a company registered anywhere else, Xtrm sets it to International, whatever you send.

        Allowed values: USA Only, International.

Response fields

  • AdvancedProfileResponseobject

    Wrapper object for the response.

    Child parameters1
    • AdvancedProfileResultobject

      Result of the submission.

      Child parameters3
      • BeneficiaryIDstring

        The SPN account number of the company whose profile was updated.

      • Messagestring

        Confirms the submission, e.g. Advanced Profile Submitted Successfully. When the call fails, read OperationStatus.Errors instead.

      • OperationStatusobject

        Outcome of the operation.

        Child parameters2
        • Successboolean

          Whether the operation succeeded (true or false).

        • Errorsstring[]

          Error messages when the call fails, as an array of strings. On success it's null or an empty array [], so decide with Success.

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

POST/API/v4/Register/CompanyAdvancedProfileStatus

Returns 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

  • AdvancedProfileStatusobjectRequired

    Wrapper object for the request.

    Child parameters1
    • requestobjectRequired

      The status query.

      Child parameters2
      • IssuerAccountNumberstringRequired

        The SPN account number of the company whose API credentials you are using. If you use pseudo credentials, the SPN of the company you are acting on behalf of.

      • BeneficiaryAccountNumberstringRequired

        The SPN account number of the company whose profile status you're checking.

Response fields

  • AdvancedProfileStatusResponseobject

    Wrapper object for the response.

    Child parameters1
    • AdvancedProfileStatusResultobject

      Result of the status query.

      Child parameters3
      • BeneficiaryIDstring

        The SPN account number of the company whose profile status was queried.

      • Messagestring

        The current status of the advanced profile application: Submitted, Pending, Approved, or Deactive.

      • OperationStatusobject

        Outcome of the operation.

        Child parameters2
        • Successboolean

          Whether the operation succeeded (true or false).

        • Errorsstring[]

          Error messages when the call fails, as an array of strings. On success it's null or an empty array [], so decide with Success.

Related: Submit a company advanced profile · Get advanced profile details

#Get advanced profile details

POST/API/v4/Register/GetCompanyAdvancedProfileDetails

Returns 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

  • AdvancedProfileDetailsobjectRequired

    Wrapper object for the request.

    Child parameters1
    • requestobjectRequired

      The details query.

      Child parameters2
      • IssuerAccountNumberstringRequired

        The SPN account number of the company whose API credentials you are using. If you use pseudo credentials, the SPN of the company you are acting on behalf of.

      • BeneficiaryAccountNumberstringRequired

        The SPN account number of the company whose profile you are querying.

Response fields

  • AdvancedProfileDetailsResponseobject

    Wrapper object for the response.

    Child parameters1
    • AdvancedProfileDetailsResultobject

      The advanced profile details.

      Child parameters8
      • BeneficiaryAccountNumberstring

        The SPN account number of the company.

      • Country_Of_Registration_Code2string

        Two-character ISO country code where the business is officially registered.

      • Payments_Typestring

        Expected geographical scope of payments, e.g. USA Only or International.

      • Statusstring

        Approval status of the application: Approved, Pending, or empty or null. It can be empty even once Xtrm has approved the profile, so take the review status from CompanyAdvancedProfileStatus.

      • BusinessEntityInformationobject

        Information about the business entity.

        Child parameters23
        • Legal_Company_Namestring

          Legal name of the company, from its Xtrm account.

        • Fictitious_Namestring

          The company's "doing business as" (DBA) or fictitious trade name.

        • Websitestring

          Official website URL or domain of the company.

        • Company_Typestring

          Legal structure or corporate classification of the company.

        • Industry_Classificationstring

          General category of the business.

        • Country_Of_Incorporation_Code2string

          Two-character ISO country code where the business is officially incorporated.

        • Region_Of_Incorporation_Code2string

          Two-character state or region abbreviation where the business is officially incorporated.

        • Tax_Identification_Numberstring

          Official tax identifier for the company, such as a US EIN, SSN, or international equivalent.

        • Identification_Typestring

          Type of the authorized contact's government-issued identification document, e.g. Passport.

        • Identification_Numberstring

          Number of the authorized contact's government-issued identification document.

        • Address_Line_1string

          Primary street address of the business's headquarters.

        • Address_Line_2string

          Additional street address information (suite, floor) for the business headquarters.

        • Address_Line_3string

          Additional street address information for the business headquarters.

        • Citystring

          City where the business's headquarters is located.

        • Country_Code2string

          Two-character ISO 3166-1 alpha-2 country code of the business's headquarters.

        • Region_Code2string

          Two-character state or region abbreviation for the business's headquarters.

        • Postal_Codestring

          ZIP or postal code of the business's primary headquarters.

        • Purpose_Of_Transactionsstring

          The nature of and reason for the business's transactions.

        • Expected_Currenciesstring

          Currencies the business expects to transact in.

        • Expected_Annual_Volumestring

          Projected total annual processing volume as a numeric string.

        • Expected_Per_Transaction_Amountstring

          Projected average amount per transaction as a numeric string.

        • Countries_Sending_Tostring

          Countries the business expects to make payments to.

        • Countries_Receiving_Fromstring

          Countries the business expects to receive funds from.

      • AuthorizedContactInformationobject

        The authorized contact for the company.

        Child parameters13
        • Job_Titlestring

          Professional title or role of the authorized contact within the company.

        • Job_Title_Otherstring

          The authorized contact's job title when Job_Title is Other. Empty in the examples.

        • First_Namestring

          Legal first name of the authorized contact.

        • Last_Namestring

          Legal last name of the authorized contact.

        • Email_Addressstring

          Direct professional email address of the authorized contact.

        • Date_Of_Birthstring

          The authorized contact's date of birth in mm/dd/yyyy format.

        • Citizenshipstring

          Two-character ISO country code of the authorized contact's primary citizenship.

        • Address_Line_1string

          Primary street address of the authorized contact.

        • Citystring

          City of residence of the authorized contact.

        • Region_Code2string

          Two-character state, province, or region abbreviation for the authorized contact.

        • Country_Code2string

          Two-character ISO 3166-1 alpha-2 country code for the authorized contact.

        • Postal_Codestring

          ZIP or postal code of the authorized contact's address.

        • Business_Phonestring

          The authorized contact's business phone number, as submitted.

      • OwnerInformationobject

        Ownership information.

        Child parameters4
        • IsPublicallyTradedstring

          Whether the company is publicly traded: yes or no, in any capitalization, e.g. "No". Compare it without regard to case.

        • IsEligibleOwnershipboolean

          Whether one or more people own 26% or more of the company (true or false). When it's true, Owners lists them.

        • Ticker_Symbolstring

          Stock 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 IsEligibleOwnership false.

          Child parameters13
          • Address_Line_1string

            Primary street address of the owner.

          • Citizenshipstring

            Two-character ISO country code of the owner's primary citizenship.

          • Citystring

            City of residence of the owner.

          • Country_Code2string

            Two-character ISO 3166-1 alpha-2 country code for the owner.

          • Date_of_Birthstring

            The owner's date of birth in mm/dd/yyyy format.

          • Email_Addressstring

            Direct email address of the owner.

          • First_Namestring

            Legal first name of the owner.

          • Job_Titlestring

            Professional title or role of the owner.

          • Last_Namestring

            Legal last name of the owner.

          • Middle_Namestring

            Legal middle name of the owner.

          • Percentage_Ownedstring

            Percentage of the company this owner holds, as a whole number in a string, e.g. "60".

          • Postal_Codestring

            ZIP or postal code of the owner's address.

          • Region_Code2string

            Two-character state, province, or region abbreviation for the owner.

      • OperationStatusobject

        Outcome of the operation.

        Child parameters2
        • Successboolean

          Whether the operation succeeded (true or false).

        • Errorsstring[]

          Error messages when the call fails, as an array of strings. On success it's null or an empty array [], so decide with Success.

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

POST/API/v4/Register/GetAdvancedContactCountry

Returns 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.

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

  • AdvancedContactCountryResponseobject

    Wrapper object for the response.

    Child parameters1
    • AdvancedContactCountryResultobject

      Result of the lookup.

      Child parameters2
      • AdvancedContactCountryobject

        The country list.

        Child parameters1
        • AdvancedContactCountryDetailsobject[]

          One entry per country.

          Child parameters2
          • CountryCodestring

            Two-character ISO country code (ISO 3166-1 alpha-2), e.g. US.

          • CountryNamestring

            Full registered name of the country.

      • OperationStatusobject

        Outcome of the operation.

        Child parameters2
        • Successboolean

          Whether the operation succeeded (true or false).

        • Errorsstring[]

          Error messages when the call fails, as an array of strings. On success it's null or an empty array [], so decide with Success.

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

POST/API/v4/Register/GetAdvancedContactState

Returns 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.

Body parameters

  • AdvancedContactStateobjectRequired

    Wrapper object for the request.

    Child parameters1
    • requestobjectRequired

      The lookup query.

      Child parameters1
      • CountryCodestringRequired

        Two-character ISO country code (ISO 3166-1 alpha-2) of the country whose regions you want, e.g. US.

Response fields

  • AdvancedContactStateResponseobject

    Wrapper object for the response.

    Child parameters1
    • AdvancedContactStateResultobject

      Result of the lookup.

      Child parameters2
      • AdvancedContactStateobject

        The region list.

        Child parameters1
        • AdvancedContactStateDetailsobject[]

          One entry per region.

          Child parameters2
          • StateCodestring

            The region's identifier. In the example it's the region's full name in capitals, such as ALABAMA, the same as StateName, not the two-character code that the advanced profile's region fields take.

          • StateNamestring

            The region's full name, in capitals, for example ALABAMA.

      • OperationStatusobject

        Outcome of the operation.

        Child parameters2
        • Successboolean

          Whether the operation succeeded (true or false).

        • Errorsstring[]

          Error messages when the call fails, as an array of strings. On success it's null or an empty array [], so decide with Success.

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

POST/API/v4/Register/GetAdvancedContactCompanyType

Returns 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

  • CompanyTypeobjectRequired

    Wrapper object for the request.

    Child parameters1
    • requestobjectRequired

      The lookup query.

      Child parameters1
      • CountryISO2stringRequired

        Two-character ISO country code of the country to retrieve company types for, e.g. US.

Response fields

  • CompanyTypesResponseobject

    Wrapper object for the response.

    Child parameters1
    • CompanyTypeResultobject

      Result of the lookup.

      Child parameters2
      • CompanyTypesobject

        The company type list.

        Child parameters1
        • CompanyTypeDetailsobject[]

          One entry per company type.

          Child parameters1
          • CompanyTypestring

            A recognized legal structure for companies in the requested country.

      • OperationStatusobject

        Outcome of the operation.

        Child parameters2
        • Successboolean

          Whether the operation succeeded (true or false).

        • Errorsstring[]

          Error messages when the call fails, as an array of strings. On success it's null or an empty array [], so decide with Success.

Related: List countries for an advanced profile · Submit a company advanced profile

#List NAICS industry types

POST/API/v4/Register/GetNAICS

Returns 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

  • NAICSResponseobject

    Wrapper object for the response.

    Child parameters1
    • NAICSResultobject

      Result of the lookup.

      Child parameters2
      • NAICSobject

        The industry list.

        Child parameters1
        • NAICSDetailsobject[]

          One entry per industry type.

          Child parameters1
          • Industrystring

            General classification of the business industry, e.g. Accommodation.

      • OperationStatusobject

        Outcome of the operation.

        Child parameters2
        • Successboolean

          Whether the operation succeeded (true or false).

        • Errorsstring[]

          Error messages when the call fails, as an array of strings. On success it's null or an empty array [], so decide with Success.

Related: Submit a company advanced profile

#List standard job titles

POST/API/v4/Register/GetAdvancedContactJobTitles

Returns 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

  • JobTitlesResponseobject

    Wrapper object for the response.

    Child parameters1
    • JobTitlesResultobject

      Result of the lookup.

      Child parameters2
      • JobTitlesobject

        The job title list.

        Child parameters1
        • JobTitlesDetailsobject[]

          One entry per job title.

          Child parameters1
          • JobTitlestring

            A standard job title or professional designation.

      • OperationStatusobject

        Outcome of the operation.

        Child parameters2
        • Successboolean

          Whether the operation succeeded (true or false).

        • Errorsstring[]

          Error messages when the call fails, as an array of strings. On success it's null or an empty array [], so decide with Success.

Related: Submit a company advanced profile

#List identification types

POST/API/v4/Register/GetIdentificationType

Returns 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

  • IdentificationTypeResponseobject

    Wrapper object for the response.

    Child parameters1
    • IdentificationTypeResultobject

      Result of the lookup.

      Child parameters2
      • IdentificationTypeobject

        The identification type list.

        Child parameters1
        • IdentificationTypeDetailsobject[]

          One entry per identification type.

          Child parameters1
          • IdentificationTypestring

            Name of an identity document type, e.g. Passport.

      • OperationStatusobject

        Outcome of the operation.

        Child parameters2
        • Successboolean

          Whether the operation succeeded (true or false).

        • Errorsstring[]

          Error messages when the call fails, as an array of strings. On success it's null or an empty array [], so decide with Success.

Related: Submit a company advanced profile