Overview
As part of the new USD rail release, we have upgraded our KYC endpoints to be more flexible and easier to implement. This includes endpoints for uploading documentation and a new response schema.The new USD rail requires using the updated flow. You must use the new
documentation endpoint to upload user documents. Failing to do so will result
in a 400 error when submitting the application.
- nationality (string): Three-letter alpha-3 country code as defined in the ISO 3166-1 spec
Step 1: Create an Individual User
Before providing additional details, you must first create an individual user. This step is consistent with the previous KYC flow, requiring basic user information at creation. Wallet addresses will be automatically assigned to the user by default. POST/v2/users
Step 2: Upload KYC Information
After creating the user, you can provide the additional KYC information required for the USD rail. POST/v2/users/{userId}/kyc
Step 3: Upload Documentation
Users can now upload raw documentation directly. HIFI will return a file ID, which can later be used to attach the document to the user.Upload Documentation
POST/v2/files
Add Documentation to User
After receiving thefileId
, you can attach the documentation to the user. For the documentation required for the USD rail, please refer to Individual Documents.
POST /v2/users/{userId}/kyc/documents
Step 4: Check KYC Requirements (Optional)
You can use the “Check KYC Requirements” endpoint to verify any missing or invalid information before submitting the KYC application. GET/v2/users/{userId}/kyc/requirements
Step 5: Submit KYC
Once all required information has been submitted, you can now submit the KYC application to our new USD rail! POST/v2/users/{userId}/kyc/submissions
Step 6: Retrieve KYC Status
After submitting the KYC application, you can retrieve the latest screening result. GET/v2/users/{userId}/kyc/status