Users

Retrieve KYC

Retrives a User KYC by userID.

get/users/{userID}/kyc-status

Request

Base URL
https://bo-api.drivewealth.io/back-office
URL
https://bo-api.drivewealth.io/back-office/users/{userID}/kyc-status
Auth
HTTP bearer

Path parameters

userIDstring required

sensitive Unique ID of the User to fetch their profile & kyc status.

Response

Fetching User's Profile Details & KYC is Successful.

userIDstring

sensitive A unique identifier created for each User on DriveWealth's platform.

firstNamestring

sensitive The first name of the user.

lastNamestring

sensitive The last (family) name of the user.

Example response

{
  "userID": "123e4567-e89b-12d3-a456-000000000004",
  "firstName": "John",
  "lastName": "Smith",
  "identity": {
    "number": "****-4444",
    "dob": "2000-12-03"
  },
  "accounts": [
    {
      "id": "123e4567-e89b-12d3-a456-00000000005c.1234567890143",
      "accountNo": "FFFF000005",
      "nickname": "John's Self Directed Account",
      "accountStatus": {
        "name": "PENDING",
        "description": "Pending"
      },
      "accountType": "LIVE",
      "accountManagementType": "SELF",
      "tradingType": "CASH",
      "leverage": 1
    }
  ],
  "kyc": {
    "status": {
      "name": "KYC_INFO_REQUIRED",
      "code": "K102",
      "description": "User's PII not matched. Please revisit user's PII Info."
    },
    "approved": {
      "timestamp": "2022-12-12T21:13:12.391Z",
      "approvedBy": "123e4567-e89b-12d3-a456-000000000160"
    },
    "accepted": {
      "acceptedBy": "SYSTEM PRINCIPAL APPROVER",
      "timeStamp": "2022-12-12T21:13:12.391Z"
    }
  },
  "status": {
    "name": "APPROVED",
    "description": "User approved."
  },
  "partnerID": {
    "id": "123e4567-e89b-12d3-a456-000000000005",
    "name": "Tendies Trading Company"
  },
  "documents": []
}

Changes

No recorded changes to this operation across all 1 revision of this API.