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
  • Schemas
    • Schemas
      • InstrumentType
      • ErrorModel
      • UserRequestModel
      • AddressModel
      • ContactModel
      • AuthRequestModel
      • UserDetailModel
      • AuthResponseModel
      • UserModel
      • DocumentUploadModel
      • MerchantModel
      • FundingSourceResponseModel
      • FundingSourceRequestModel
      • RaiseFundingDocumentModel
      • CardConfigModel
      • CardPoi
      • CardProgramRequestModel
      • CardAmountModel
      • FeesApplicationCardRequest
      • FeeApplicationEventResponse
      • StatementResponse
      • MerchantDetailModel
      • MerchantListModel
      • VelocityControlConfigModel
      • StatementResponseDetails
      • VelocityControlDetailConfigModel
      • RuleGroupResponseModel
      • TransactionResponse
      • RuleGroupModel
      • TransactionResponseDetails
      • RuleGroupTransactionRestrictions
      • TransactionRequestModel
      • RuleGroupMerchantRules
      • FileUploadModel
      • RuleGroupLoadRestrictions
      • DocumentModel
      • RuleGroupSpendRestrictions
      • CardStatusModel
      • CardRenewalModel
      • ApplyFeesOnCardRequest
      • FeesStatusUpdateModel
      • FeesSetupModel
      • CardProgramTransferFundsModel
      • RaiseFundingRequestModel
      • Webhook
      • CardRequestModel
      • FeeConfigurationModel
      • CardResponseModel
      • CardStatementResponse
      • CardProgramStatusChangeRequestModel
      • CardProgramCreationWebhook
      • AmountModel
      • WebhookEventType
      • WebhookEventModel
      • WebhookRequestModel
      • WebhookResponseModel
      • CardActivationWebhook
      • FundingSourceBalanceModel
      • CompanyUuidParameter
      • CardIssuanceWebhook
      • RequestUuidParameter
      • CardPinSetupWebhook
      • UserUuidParameter
      • CardRenewedWebhook
      • CardUuidParameter
      • MaskedPanParameter
      • CardProgramResponseModel
      • CardStatusChangeWebhook
      • CardTypeChangeWebhook
      • CardStatusParameter
      • CardLoadWebhook
      • TransactionIdParameter
      • TransactionUuidParameter
      • CardUnloadWebhook
      • TransactionTypeParameter
      • CardToCardTransferWebhook
      • CardToHolderCreationWebhook
      • CardToHolderUpdationWebhook
      • CardToHolderDeletionWebhook
      • FundTransferWebhook
      • RaiseFundingWebhook
      • CardHolderCreationWebhook
      • TransactionWebhook
      • CardHolderUpdationWebhook
      • TransactionEnrichmentWebhook
      • CardHolderDeletionWebhook
      • FeesApplyWebhook
      • UserWebhook
      • RuleGroupCreationWebhook
      • RuleGroupUpdationWebhook
      • RuleGroupDeletionWebhook
      • WalletRuleGroupCreationWebhook
      • WalletRuleGroupDeletionWebhook
      • CardRuleGroupCreationWebhook
      • CardRuleGroupDeletionWebhook
    • Response
      • EntityNotFoundError
  1. User

Retrieve a User

GET
https://{{env}}-lb.simplifipay.com/v1/user/{uuid}
User
The Retrieve a User endpoint retrieves details about an existing user.
Following are the properties of this endpoint.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://uat-lb.simplifipay.com/v1/user/' \
--header 'requestUuid;'
Response Response Example
200 - Example 1
{
    "uuid": "f242acc1-bcbf-11eb-8529-c070bc3a2323",
    "username": "johnsmith",
    "firstName": "John",
    "middleName": "M",
    "lastName": "Smith",
    "gender": "MALE",
    "userStatus": "ACTIVE",
    "kycStatus": "NOT_SUBMITTED",
    "createdAt": "2025-02-28 13:31:00",
    "createdBy": "a49d6f6e-c98b-47db-9d6f-6ec98b77dbf9",
    "userDetail": {
        "cardProgramUuid": "a0f07d6c-d6e8-4bda-9dcc-f64fb3a720f6",
        "dob": "2025-02-28 13:31:00",
        "roleName": "CUSTOMER",
        "position": "Employee"
    },
    "address": {
        "addressType": "PRIMARY",
        "streetAddress": "string",
        "address2": "string",
        "cityCode": "string",
        "stateCode": "string",
        "countryCode": "string",
        "postalCode": "string"
    },
    "contacts": [
        {
            "contactType": "PHONE",
            "contactValue": "+971123456789, john.smit@simplifipay.com"
        }
    ]
}

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
or
Path Params

Header Params

Responses

🟢200OK
application/json
OK
Body

🟠400Bad Request
🟠401Unauthorized
Modified at 2025-06-27 12:44:57
Previous
Upload Document
Next
Update a User
Built with