API 2.0 simplifies the settlement process by dividing responsibilities between the employer's integration, Useme, and the contractor.The employer initiates a deal through the API. Useme then guides the contractor through the steps required to complete the settlement.Process overview#
1.
The employer selects the appropriate category and subcategory.
2.
The employer creates a deal and provides the contractor's email address.
3.
Useme identifies the contractor or creates an initial account if necessary.
4.
Useme contacts the contractor and guides them through the contractor-facing process.
5.
The employer tracks the deal until the settlement is completed.
Selecting a category#
Each deal must be assigned to a subcategory. Categories provide a broad classification, while subcategories describe the type of work more precisely.The employer should retrieve the currently available categories and select the most appropriate subcategory before creating a deal.Creating a deal#
To create a deal, the employer provides the contractor's email address and the basic information describing the work and settlement.The contractor does not need to have an existing Useme account. Useme automatically checks the supplied email address:if the contractor already exists, the deal is linked to their account;
if the contractor is new, Useme creates an initial account and invites them to continue the process.
A deal cannot be updated through API 2.0 after it has been created. Verify the contractor's email address and all deal information before submitting it.
Contractor onboarding#
After the deal has been created, Useme sends the contractor an email with a secure link.The contractor continues the process directly in Useme. Depending on their account and profile status, they may be asked to:complete their personal and tax information;
review and accept the deal;
confirm that the work has been completed;
upload a work file when required.
Work files#
Work files are not uploaded through API 2.0. If a file is required, the contractor provides it directly in the Useme web interface as part of the settlement process.In some cases, Useme may generate the required work confirmation automatically, so a manual file upload is not always necessary.Tracking the deal#
The employer can use the API to monitor the deal after it has been created. This makes it possible to synchronize the employer's system with the current state of the settlement, including payment and completion.The API also allows the employer to list their deals and retrieve more information about a selected deal.Technical details, request and response formats, and the available deal statuses are described in the API Reference.Deal statuses#
A deal moves through a defined set of statuses as it progresses from creation to settlement. The employer can retrieve the current status at any time via the tracking endpoints described in the API Reference.created – The deal has been successfully created in Useme.
processing – The deal is awaiting verification and the generation/issuance of the proforma invoice to the employer.
waiting_for_payment – The proforma invoice has been issued and payment from the employer is pending.
paid_in – Payment from the employer has been received; payout to the contractor is currently in progress.
finished – The deal is completed and funds have been successfully transferred to the contractor.
cancelled – The deal has been cancelled. For details or questions, contact your account manager or reach out to info@useme.com. other – A non-standard issue has been detected and the deal has been put on hold. Direct contact with Useme support is required.
What changed in API 2.0?#
contractors are identified by email and handled automatically during deal creation;
contractor details are completed by the contractor in Useme;
a separate contractor creation step is no longer required;
work files are not uploaded by the employer through the API;
the employer uses the API primarily to create and track deals.
