nametypeDescription
NOTE: The userDetailsUrl must accept a query parameter of “tag”
The response data from the userDetailsUrl must follow this user format
typescript
{
id: string;
fullname: string;
tag: string;
avatar: string;
email: string;
emailVerified: boolean;
phone: string;
dateOfBirth: Date;
countryCode: string;
gender: string;
isAdult: boolean;
bvn: string;
accountNumber: string;
kyc: {
id: string;
bvn: string;
streetAddress: string;
city: string;
state: string;
postalCode: string;
country: string;
proofOfAddress: string;
governmentId: string;
userPhoto: string;
bvnProvided: boolean;
bvnValidated: boolean;
addressProvided: boolean;
addressValidated: boolean;
idProvided: boolean;
idValidated: boolean;
isCompleted: boolean;
verificationStatus: string;
phone: string;
phoneVerified: boolean;
phoneCodeExpiresAt: Date;
}
}
cURL
curl --request PATCH
'https://test-api.bvndle.com/api/v1/ufel/partners' \
--header 'Content-Type: application/json' \
{
"partnerName": "test partner"
}
{
"status": "success",
"message": "Partner details updated successfully"
}
{
"status": "failed",
"message": "invalid data provided",
"data": {
"errorType": "invalid",
"appErrorCode": "Bad request",
"error": "\"email\" is not allowed"
}
}