Managing platforms

Onboard a client company

Take a client company from first contact to its first batch payment. You do most of it through the API on the company's behalf. Its identity documents go through the Xtrm web app, and once Xtrm approves the company, its payments run through the same API calls you already use.

This guide is for managing platforms. If you're paying from your own account, start with the Quickstart instead. For the model behind these steps, see How managing platforms work.

#Before you begin

  • A company account of your own with API credentials. See Sandbox & environments. This guide uses SPN1111222.
  • The client company's details: its legal name, address and ownership for its advanced profile, plus its documents to upload in the Xtrm web app: a government-issued photo ID for its administrator and, for a private company, a company tax document such as a W-9 for a US company. See Complete the advanced profile. This guide uses Contoso Ltd, account SPN7777555.

#Steps

  1. Get approved as a manager

    Xtrm designates your company account as a manager account. Ask your account administrator or the Xtrm onboarding team, or email [email protected]. In the web app, a manager account shows a red star next to its name, a connected company a blue link icon, and a company approved for Advanced Services a gold star. See Icons in the web app.

    Tell Xtrm which manager services you need, and Xtrm turns them on for your company. Pseudo credentials require manager services, so you need at least Get API Credentials, which gives you each client company's pseudo credentials in step 6. To upload a client company's identity documents for it in step 3, you also need Identity Documents. In the API, a connection is all a call needs, so you can submit the client company's advanced profile without a manager service. See Manager services.

  2. Connect to the client company

    If the client company doesn't have an Xtrm account yet, create it with CreateBeneficiary. It's connected to your company from the start, and the response's ClientID and SecretKey are your pseudo credentials for it, which you'll use from step 6.

    If it already has an account, connect to it with a one-time password that Xtrm sends to its primary contact, as in Connect existing accounts, or send it a connection request in the Xtrm web app. See How accounts become connected.

    Check the connection with GetConnectedStatus: your own SPN in IssuerAccountNumber and SPN7777555 in UserID. Continue once Status is exactly Connected. See Check a connection for the other values.

  3. Complete the client company's Identity profile in the web app

    Creating or connecting the client company doesn't finish its onboarding. Its identity verification level (IDL), shown in the web app as profile completeness, has to reach 100%, which the API reports as Advanced. CheckBeneficiaryExist returns the company's level in AccountIdentityLevel, and GetBeneficiaries in BeneficiaryAccountIdentityLevel. The level rises as the company's profile fills in:

    • Draft: the bare minimum, an email address.
    • Basic: adds the contact's first and last name and the company name.
    • Standard: adds the business address.
    • Advanced: adds the business tax ID and 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. A public company needs only the photo ID. The profile is 100% complete.

    Onboarding isn't API-only. No API call uploads documents, so the client company's documents are uploaded in the Xtrm web app, in one of two ways:

    • Your company uploads them for it. Open Contacts > Company Contacts, open the client company's profile and choose Identity Documents in its Connected Manager Services menu. This needs that manager service, and an admin with the Master Admin or Controller role and the Connected Manager Services permission. Identity Profile in the same menu edits the company's organization details, such as its business tax ID.
    • Or you ask the client company to upload them itself, from its own account: Identity > Identity Documents > Upload Identity Documents.

    Each file can be up to 20 MB, as JPEG, BMP, PNG, PDF, DOC or DOCX. Complete the advanced profile has the details for each document.

    Continue once CheckBeneficiaryExist returns Advanced for SPN7777555. In the web app, the client company's Advanced Services Application opens only once its Identity profile is 100% complete.

  4. Submit the client company's advanced profile

    Now submit the company's advanced profile, the Advanced Services application Xtrm reviews before the company can pay. Send it with CompanyAdvancedProfile: your own SPN in IssuerAccountNumber and SPN7777555 in BeneficiaryAccountNumber. Follow its review with CompanyAdvancedProfileStatus. Complete the advanced profile covers every field.

  5. Wait for approval

    Xtrm reviews the advanced profile, usually in 1 to 2 days for a USA Only profile and 5 to 7 days for an International one (its Payments_Type). Check the status on a schedule, such as a few times a day, until it's Approved. Once it's approved, Xtrm unlocks funding for the client company's account, and the company can fund its wallets and pay. In the web app, the client company then shows a gold star next to its name.

    Until then, the company's funding requests are refused with a message such as Advanced service not approved. Please complete Advanced Services Application. Wait for approval and a funded wallet before you submit the company's first batch.

  6. Get the client company's pseudo credentials

    If you created the client company with CreateBeneficiary in step 2, you already have them: they're the ClientID and SecretKey in its response. Otherwise, get them in the Xtrm web app with Get API Credentials, as Pseudo credentials shows.

    Store the client ID and secret as securely as your own, apart from every other client company's.

  7. Fund the client company's wallet

    With the client company's pseudo credentials, request an access token and list the company's wallets with GetCompanyWallets, sending SPN7777555 in IssuerAccountNumber. This guide uses Contoso Ltd's USD wallet, 122501. Then add money to the wallet that will fund its batches. See Fund your wallet.

  8. Create the client company's recipients

    A batch pays existing Xtrm accounts only, so create each recipient before the batch that pays it. Add the people and businesses the client company pays, with the client company's token and SPN7777555 in IssuerAccountNumber. For each one, search first so you don't open a second account: CheckUserExist for a person, then CreateUser if there's no account, and CheckBeneficiaryExist for a business, searching by its email domain when you know it, then CreateBeneficiary. Pay individual recipients and Pay business recipients walk through both.

    Recipients you create this way belong to the client company. They're connected to the client company and to your platform, so you can link their bank accounts with the client company's credentials. A recipient that already has an Xtrm account can be paid as it is, and needs a connection only for more than that. See Connections and manager services.

    A business you create with the client company's token comes with a ClientID and SecretKey too: they're pseudo credentials for the new business, issued to the client company, not to your platform. Keep them as securely as the client company's own.

  9. Pay the client company's first batch

    Submit a batch exactly as in Create a batch payment, with the client company's token, SPN7777555 in IssuerAccountNumber and its wallet 122501 in SourceWalletId. The batch, its statuses and its webhooks all belong to the client company.

    Each client company gets its own webhook endpoint, which Xtrm support sets up with you. See Run many client companies side by side.

#Next steps