GET api/superadmin/vendors/{vendorId}/kyc-details

Request Information

URI Parameters

NameDescriptionTypeAdditional information
vendorId

integer

Required

Body Parameters

None.

Response Information

Resource Description

VendorKycDetails
NameDescriptionTypeAdditional information
VendorId

integer

None.

CompanyName

string

None.

BusinessType

string

None.

BusinessDescription

string

None.

RegistrationNo

string

None.

VatNumber

string

None.

Email

string

None.

PhoneNumber

string

None.

WebsiteAddress

string

None.

FullAddress

string

None.

ApplicationStatus

integer

None.

DateCreated

date

None.

LastModified

date

None.

OwnerInfo

OwnerInfo

None.

Documents

Collection of VendorDocumentInfo

None.

TransactionHistory

Collection of TransactionSummary

None.

TotalTransactions

integer

None.

TotalTransactionVolume

decimal number

None.

Response Formats

application/json, text/json

Sample:
{
  "VendorId": 1,
  "CompanyName": "sample string 2",
  "BusinessType": "sample string 3",
  "BusinessDescription": "sample string 4",
  "RegistrationNo": "sample string 5",
  "VatNumber": "sample string 6",
  "Email": "sample string 7",
  "PhoneNumber": "sample string 8",
  "WebsiteAddress": "sample string 9",
  "FullAddress": "sample string 10",
  "ApplicationStatus": 11,
  "DateCreated": "2026-03-26T03:50:59.2089789+02:00",
  "LastModified": "2026-03-26T03:50:59.2089789+02:00",
  "OwnerInfo": {
    "UserId": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Email": "sample string 4",
    "PhoneNumber": "sample string 5",
    "IDNumber": "sample string 6",
    "AccountCreated": "2026-03-26T03:50:59.2089789+02:00"
  },
  "Documents": [
    {
      "Id": 1,
      "DocumentType": 2,
      "FileName": "sample string 3",
      "FileType": "sample string 4",
      "DateUploaded": "2026-03-26T03:50:59.2089789+02:00",
      "Verified": true,
      "VerifiedBy": "sample string 7",
      "VerificationDate": "2026-03-26T03:50:59.2089789+02:00",
      "VerificationNotes": "sample string 8"
    },
    {
      "Id": 1,
      "DocumentType": 2,
      "FileName": "sample string 3",
      "FileType": "sample string 4",
      "DateUploaded": "2026-03-26T03:50:59.2089789+02:00",
      "Verified": true,
      "VerifiedBy": "sample string 7",
      "VerificationDate": "2026-03-26T03:50:59.2089789+02:00",
      "VerificationNotes": "sample string 8"
    }
  ],
  "TransactionHistory": [
    {
      "TransactionRef": "sample string 1",
      "Amount": 2.0,
      "TransactionType": 1,
      "DateCreated": "2026-03-26T03:50:59.2089789+02:00",
      "Status": 1
    },
    {
      "TransactionRef": "sample string 1",
      "Amount": 2.0,
      "TransactionType": 1,
      "DateCreated": "2026-03-26T03:50:59.2089789+02:00",
      "Status": 1
    }
  ],
  "TotalTransactions": 13,
  "TotalTransactionVolume": 14.0
}

application/xml, text/xml

Sample:
<VendorKycDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <ApplicationStatus>11</ApplicationStatus>
  <BusinessDescription>sample string 4</BusinessDescription>
  <BusinessType>sample string 3</BusinessType>
  <CompanyName>sample string 2</CompanyName>
  <DateCreated>2026-03-26T03:50:59.2089789+02:00</DateCreated>
  <Documents>
    <VendorDocumentInfo>
      <DateUploaded>2026-03-26T03:50:59.2089789+02:00</DateUploaded>
      <DocumentType>2</DocumentType>
      <FileName>sample string 3</FileName>
      <FileType>sample string 4</FileType>
      <Id>1</Id>
      <VerificationDate>2026-03-26T03:50:59.2089789+02:00</VerificationDate>
      <VerificationNotes>sample string 8</VerificationNotes>
      <Verified>true</Verified>
      <VerifiedBy>sample string 7</VerifiedBy>
    </VendorDocumentInfo>
    <VendorDocumentInfo>
      <DateUploaded>2026-03-26T03:50:59.2089789+02:00</DateUploaded>
      <DocumentType>2</DocumentType>
      <FileName>sample string 3</FileName>
      <FileType>sample string 4</FileType>
      <Id>1</Id>
      <VerificationDate>2026-03-26T03:50:59.2089789+02:00</VerificationDate>
      <VerificationNotes>sample string 8</VerificationNotes>
      <Verified>true</Verified>
      <VerifiedBy>sample string 7</VerifiedBy>
    </VendorDocumentInfo>
  </Documents>
  <Email>sample string 7</Email>
  <FullAddress>sample string 10</FullAddress>
  <LastModified>2026-03-26T03:50:59.2089789+02:00</LastModified>
  <OwnerInfo>
    <AccountCreated>2026-03-26T03:50:59.2089789+02:00</AccountCreated>
    <Email>sample string 4</Email>
    <FirstName>sample string 2</FirstName>
    <IDNumber>sample string 6</IDNumber>
    <LastName>sample string 3</LastName>
    <PhoneNumber>sample string 5</PhoneNumber>
    <UserId>sample string 1</UserId>
  </OwnerInfo>
  <PhoneNumber>sample string 8</PhoneNumber>
  <RegistrationNo>sample string 5</RegistrationNo>
  <TotalTransactionVolume>14</TotalTransactionVolume>
  <TotalTransactions>13</TotalTransactions>
  <TransactionHistory>
    <TransactionSummary>
      <Amount>2</Amount>
      <DateCreated>2026-03-26T03:50:59.2089789+02:00</DateCreated>
      <Status>1</Status>
      <TransactionRef>sample string 1</TransactionRef>
      <TransactionType>1</TransactionType>
    </TransactionSummary>
    <TransactionSummary>
      <Amount>2</Amount>
      <DateCreated>2026-03-26T03:50:59.2089789+02:00</DateCreated>
      <Status>1</Status>
      <TransactionRef>sample string 1</TransactionRef>
      <TransactionType>1</TransactionType>
    </TransactionSummary>
  </TransactionHistory>
  <VatNumber>sample string 6</VatNumber>
  <VendorId>1</VendorId>
  <WebsiteAddress>sample string 9</WebsiteAddress>
</VendorKycDetails>