{
  "status": "success",
  "message": "Partner details updated successfully"
}

​

URL

https://test-api.bvndle.com/api/v1/ufel/partners

Base URL

https://test-api.bvndle.com/api/v1/ufel

HTTP Method

PATCH

Authorization Header

Bearer ACCESS_TOKEN

​

nametypeDescription
applicationNamestringOptional
The name of the partner's application
redirectUrlstringRequired
URL to return to after exiting the authorization server. This is the default returned redirectUrl (if the deviceType query param is not passed when requesting an authorization code). This can be the same value as either webRedirectUrl or mobileRedirectUrl
webRedirectUrlstringOptional
Web URL to return to after exiting the authorization server.
mobileRedirectUrlstringOptional
Mobile URL to return to after exiting the authorization server.
partnerNamestringOptional
The partner's name
userDetailsUrlstringOptional
URL to get user details by tag

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;
    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"
}