SimpliFi
HomeContact Us
HomeContact Us
  1. User
  • Introduction
  • SimpliFi Architecture
  • Webhooks
  • Auth
    • Login to generate JWT token
      POST
  • Card Program
    • Create Card Program
      POST
    • Get Card Program
      GET
    • Change Card Program Status
      PATCH
    • Link Funding Source to Card Program
      POST
    • Get Balance of Funding Source
      GET
    • Transfer funds from one Card Program to other
      POST
    • Raise Funding Document Upload
      POST
    • Raise Funding
      POST
    • Funding Source Statement
      GET
  • Funding Source
    • Create Rule Group on Funding Account
      POST
    • Update Rule Group on Funding Account
      PUT
    • Delete Rule Group on Funding Account
      DELETE
    • Get Rule Groups on Funding Account
      GET
    • Appply Rule Group on Funding Account
      POST
    • Remove Rule Group on Funding Account
      DELETE
  • Card
    • List all Cards
      GET
    • Create a Card
      POST
    • Get Card Details
      GET
    • Retrieve Balance on the Card
      GET
    • Activate a Card
      POST
    • Manage Card Status
      POST
    • Load a Card
      POST
    • Unload a Card
      POST
    • Renewal of the Card
      POST
    • Request a Physical Card
      POST
    • Get Card Statement
      GET
    • Apply rule group on card
      POST
    • Remove rule group on card
      DELETE
  • User
    • List all Users
      GET
    • Create a User
      POST
    • Upload Document
      POST
    • Retrieve a User
      GET
    • Update a User
      PUT
    • Delete a User
      DELETE
  • Transaction
    • List All Transactions
  • Fee
    • Add fee configuration
    • Fetch fee config
    • Change the status of fee config
    • Add Fee event against card uuid in queue
    • Apply fee against card uuid present in queue
  • Webhook
    • Get all events
    • Create a webhook
    • Update a Webhook
    • Delete a Webhook
    • Updates the status of Webhook
  1. User

Upload Document

POST
https://{{env}}-lb.simplifipay.com/v1/document
The Upload Document endpoint uploads the user documents to the SimpliFi system which are required
as part of the sanctions screening or KYC process. The documents can be uploaded in one of the
following formats (.jpg, .jpeg, .png, .pdf)
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://uat-lb.simplifipay.com/v1/document' \
--header 'requestUuid;' \
--form 'file=@""' \
--form 'documentModel=""'
Response Response Example
{
    "uuid": "e2a60b44-88ef-4102-a1ac-fb0f00a3fd3e",
    "userUuid": "96f78ee1-9e0d-47b1-acc8-d4e65d711aaf",
    "documentType": "ID_CARD",
    "documentContext": "DOCUMENT_FRONT"
}

Request

Authorization
JWT
Add the parameter
Authorization
to Headers，whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
or
Header Params
requestUuid
string 
required
A unique id is required to be passed as part of the header whenever a SimpliFi API is called from your
system. This would help us in debugging in case of a discrepancy in the expected behavior of the API.
Example:
00d366f2-a6e9-4714-b172-02c4e58c29d8
Body Params multipart/form-data
file
file 
required
documentModel
object (DocumentModel) 
required
uuid
string 
optional
This is a system-generated unique identifier of the document
Example:
e2a60b44-88ef-4102-a1ac-fb0f00a3fd3e
userUuid
string 
required
This is a system-generated unique identifier of the user that was
created using the Create User API.
Example:
96f78ee1-9e0d-47b1-acc8-d4e65d711aaf
documentType
enum<string> 
required
This field contains the type of the document attached by the cardholder.
Allowed values:
ID_CARDPASSPORT
Example:
PASSPORT
documentContext
enum<string> 
required
This field contains the orientation of the document to be uploaded.
Allowed values:
DOCUMENT_FRONTDOCUMENT_BACKFACE
Example:
DOCUMENT_FRONT

Responses

🟢200OK
application/json
OK
Body
uuid
string 
optional
This is a system-generated unique identifier of the document
Example:
e2a60b44-88ef-4102-a1ac-fb0f00a3fd3e
userUuid
string 
required
This is a system-generated unique identifier of the user that was
created using the Create User API.
Example:
96f78ee1-9e0d-47b1-acc8-d4e65d711aaf
documentType
enum<string> 
required
This field contains the type of the document attached by the cardholder.
Allowed values:
ID_CARDPASSPORT
Example:
PASSPORT
documentContext
enum<string> 
required
This field contains the orientation of the document to be uploaded.
Allowed values:
DOCUMENT_FRONTDOCUMENT_BACKFACE
Example:
DOCUMENT_FRONT
🟠401Unauthorized
Modified at 2025-06-27 12:44:57
Previous
Create a User
Next
Retrieve a User
Built with