Extended User Profile

GetExtendedUserProfiles

GET {{domain}}/api/v1/profile/extended/user

Gets the list of extended user profiles

Path Parameters

Name	Type	Description
clientId	string	Client Id of the application

Query Parameters

Name	Type	Description
pageSize	integer	Page size for pagination. Default value is set to 10
pageNumber	integer	Page number for pagination. Default value is set to 1

200

{
  "message": "200",
  "data": [
    {
      "RecordId": "1fa9df62-4cf1-49a3-a249-c8d454710c2c",
      "Amount": "200.5",
      "BVN": "23451234567",
      "FirstName": "Emeka",
      "IsActive": "True"
    },
    {
      "RecordId": "afa9df62-4cf1-49a3-a249-c8d454710n71",
      "Amount": "500.5",
      "BVN": "23451234599",
      "FirstName": "John",
      "IsActive": "False"
    }
  ]
}

GetExtendedUserProfileById

GET {{domain}}/api/v1/profile/extended/user

Gets the list of extended user profiles

Path Parameters

Name	Type	Description
userId	string	User Id
clientId	string	Client Id of the application

200

{
  "message": "200",
  "data": {
    "RecordId": "1fa9df62-4cf1-49a3-a249-c8d454710c2c",
    "Amount": "200.5",
    "BVN": "23451234567",
    "FirstName": "Emeka",
    "IsActive": "True"
  }
}

CreateExtendedUserProfile

POST {{domain}}/api/v1/profile/extended/user

Creates an extended user profile

Request Body

Name	Type	Description
	object	{ "payload": { "{{attributeName}}": "{{attributeValue}}" }, "clientId": "string", "entityName": "string", "userId": "string", }

200

{
  "message": "Ok",
  "isError": false
}

UpdateExtendedUserProfile

PUT {{domain}}/api/v1/profile/extended/user

Creates an extended user profile

Request Body

Name	Type	Description
	object	{ "payload": { "{{attributeName}}": "{{attributeValue}}" }, "clientId": "string", "entityName": "string", "userId": "string", }

200

{
  "message": "Ok",
  "isError": false
}