Skip to main content

Unapprove KYC

POST /api/v1/Kyc/unapprove

Description​

This endpoint is used to revoke approval for a Know Your Customer (KYC) request for a customer.

Tags: Kyc

URL:
/api/v{version}/Kyc/unapprove

ApiKey:
No API key required

Content-Type:
application/json
text/json
application/*+json

Query Parameters:
version: string, required
Accept-Language: header, optional, change the default response message language from English (en) to French (fr) or English (en)

Request Body:
Content-Type: application/json, text/json, application/*+json
ApprovalRequest

Response:
Success, returns the KYC unapproval response.

Error Codes:
400: Bad Request
404: Resource not found
500: Internal server error

Example:

bashCopy codePOST /api/v1/Kyc/unapprove
Request Body:
{
  "customerId": "abcd-1234-efgh-5678"
}
Response:
{
  "status": "UNAPPROVED",
  "message": "KYC unapproved for customer abcd-1234-efgh-5678"
}

/api/v`{{version}}`/Kyc/unapprove

Headers​

Content-TypeValue
Accept-Language

Headers​

Content-TypeValue
Content-Typeapplication/json

Headers​

Content-TypeValue
Accepttext/plain

Body (raw)​

{
  "by": `<uuid>`,
  "kycId": `<uuid>`
}

Response: 200​

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": {
    "id": `<uuid>`,
    "tier": `<string>`,
    "name": `<string>`,
    "tenantId": `<uuid>`,
    "ownerId": `<uuid>`,
    "approved": `<boolean>`,
    "isTenant": `<boolean>`,
    "isAddressVerified": `<boolean>`,
    "approvedOn": `<dateTime>`,
    "bvn": `<string>`,
    "status": `<string>`
  }
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request POST \ 
 --url  /api/v1/Kyc/unapprove \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!