Swarm’s Onboarding API is a simple RESTful API working with JSON payloads. It expects parameters to be passed in valid JSON (except when stated otherwise) with the Content-Type: application/json header being set.

Initiate a new onboarding

To initiate a new onboarding request for your user, you will need to pass the user’s wallet address (for issuing the NFT permission token) and the source key provided to you to the Standard Onboarding endpoint. This will return an access token to your application which you can use to launch Onboarding SDK, allowing users to submit their information and documents.

Submit Source of Funds information

Collect your user’s Source of Funds information via a form, and submit to the Source of Funds API endpoint. If all the information is correct it will automatically be sent for verification and the endpoint will respond with a successful submission status.

Getting verification status

Once a user has submitted their documentation for KYC verification or Source of Funds, you can check the status of their application using the same Standard Onboarding endpoint as for initiating the onboarding.

Resubmitting incomplete information / documents

Should the KYC documents provided by the user be incomplete or not meet our regulatory requirements, the user will receive an email with a link to resubmit the missing or incomplete information. Your app will receive an access token to allow the user to continue their KYC session. For the Source of Funds verification, if the provided information is incomplete, the endpoint will return a status of in_progress_user and the user will receive an email. In this case, present the user with the Source of Funds form in your application once again, such that they can resubmit their information.