PaaS API Docs
Search
K
Comment on page

Update a Receive User

This API allows you to update the receive user information. Receive user details can only be updated if no transactions have been forwarded for delivery for the user. Hence, a receive user can only be updated when Delivery Status is NONE and in some cases, DELIVERY HOLD.

PATCH /users/{{receive_user_id}}

Individual
Business
Request Sample
Response
Fields
Updatable
Additional Details
first_name
Yes
middle_name
Yes
last_number
Yes
gender
No
Can only be updated if not provided earlier
mobile_phone
Yes
date_of_birth
Yes
email
Yes
occupation
No
Can only be updated if not provided earlier
user_relationship
No
Can only be updated if not provided earlier
address_line1
Yes
address_line2
Yes
city
Yes
state
Yes
country
No
zipcode
Yes
physical_documents
Yes
Updating physical_document object will add a new copy of the document and archive the older one.
virtual_documents
Yes
Fields
Updatable
Remarks
first_name
Yes
mobile_number
Yes
virtual_documents
No
physical_documents
Yes
address_line1
Yes
address_line2
Yes
state
Yes
city
Yes
zipcode
Yes
country
No
curl --location -g --request PATCH '{{url}}/users/{{receive_user_id}}' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"first_name": "raman",
"last_name": "machnett",
"email": "[email protected]",
"date_of_birth": "2000-01-02",
"mobile_phone": "237653801975",
"send_user_id":"3cf826ea-1d0c-46a8-a93e-4c8dc9cfbf80",
"physical_documents": [
{
"document_value": "data:image/jpg;base64,SUQsasasasas909090==",
"document_value_back": "data:image/jpg;base64,SUQsasasasas909090==",
"document_type": "OTHER",
"custom_document_type": "citizenship",
"country": "US",
"state": "Ak"
}
],
"virtual_documents": [
{
"document_value": "111111112",
"document_type": "OTHER",
"custom_document_type": "citizenship",
"expiry_date": "2025-03-10",
"id_issuing_authority": "MN",
"country": "US",
"state": "Ak"
}
]
}'
{
"address_line2": "500 8 El Camino Real Santa Clara",
"city": "Santa Clara",
"country": "GH",
"created_at": "2022-09-30T04:46:59.167529",
"date_of_birth": "2000-01-02",
"email": "[email protected]",
"first_name": "raman",
"gender": "female",
"id": "3cf826ea-1d0c-46a8-a93e-4c8dc9cfbf80",
"ip_address": "10.0.0.1",
"last_name": "machnett",
"mobile_phone": "237653801975",
"occupation": "QA",
"physical_documents": [
{
"country": "US",
"custom_document_type": "citizenship",
"document_type": "OTHER",
"id": "1731c62b-a95e-4a59-94e1-cfbe5c95978a",
"state": "Ak"
}
],
"status": "UNVERIFIED",
"user_relationship": "SISTER",
"virtual_documents": [
{
"country": "US",
"custom_document_type": "citizenship",
"document_type": "OTHER",
"document_value": "111111112",
"id": "f937c333-e76d-4fd2-b02c-01a013857ea3",
"state": "Ak",
"expiry_date": "2025-03-10",
"id_issuing_authority": "MN"
}
],
"zipcode": "23775-9K"
}