LogoLogo
Home
  • Youverify API Documentation
  • Getting Started
    • Getting your API Key
    • Getting your Public Merchant Key
    • Environment
    • Response Codes
  • Know Your Customer Services (KYC)
    • ID Document Verification (SDK)
      • Web SDK
      • iOS SDK
        • iOS Liveness SDK
        • iOS (Compat) Liveness SDK
        • iOS Document Capture SDK
      • Android SDK
        • Android Document Capture SDK
        • Android Liveness SDK
      • Document Capture Supported Countries
        • 🌏Asia
        • πŸ‡ͺπŸ‡ΊEurope
        • 🌎Latin America and the Caribbean
        • 🌍Middle East and Africa
        • 🌎North America
        • 🌏Oceania
    • ID Data Matching (eIDV)
      • 🌐Global
        • Supported Countries
      • πŸ‡ΏπŸ‡¦South Africa
        • Verify South African ID Number (SAID)
        • Verify South African Phone Number
        • Bank Account Verification
        • Proof of Address Verification
      • πŸ‡°πŸ‡ͺKenya
        • Verify International Passport
        • Verify Alien ID
        • Verify Drivers License
        • Verify Plate Number
        • Verify Collateral ID
        • Kenyan Bank Account Verification
          • Bank List
        • Credit History
        • Employment History
        • Verify Address Information
        • Verify Phone Number
        • Verify Identity Number
        • Verify Tax PIN
      • πŸ‡¬πŸ‡­Ghana
        • Verify International Passport
        • Verify Social Security and National Insurance Trust (SSNIT)
        • Verify Ghana Voters Card (GVC)
      • πŸ‡³πŸ‡¬Nigeria
        • Verify Bank Verification Number (BVN)
        • Verify Bank Verification Number (BVN Premium)
        • Verify Virtual National Identification Number (vNIN)
        • Verify National Identification Number (NIN)
        • Verify Nigerian Driver's License (Driver's License)
        • Advanced Phone Search
        • Verify Nigerian International Passport (Passport)
        • Verify Nigerian Permanent Voters Card (PVC)
        • Verify Phone Number
        • Individual Credit Report
        • Bank Account Verification
          • Basic Bank Account Verification
          • Bank List
            • Getting the list of Banks for Basic Bank Account
    • Facial Comparison
    • Retrieve an Identity
    • Identity History
  • Know Your Business Services (KYB)
    • 🌍Business Verification
    • 🌍Search for Businesses
    • Get Supported Countries and Regions
    • Retrieve Business details
    • Country-Specific KYB Services
      • πŸ‡³πŸ‡¬Nigeria
        • Tax Identification Number (TIN) Verification
      • πŸ‡ΏπŸ‡¦South Africa
        • Business Account Verification
        • Business Address Verification
  • Know Your Transaction Service (KYT)
    • Customer Management
      • Create an Individual Client
      • Create a Business Client
      • Initiate an Individual Client Assessment
      • Initiate an Business Client Assessment
      • Update a Client
      • Retrieve all Clients
      • Retrieve a Client
      • Delete a Client
    • Transaction Management
      • Create a Transaction
      • Retrieve an Evaluation
  • Risk Intelligence
    • Risk Intelligence: Initialise Risk Check
    • Retrieve Risk Intelligence Profile
    • Retrieve Risk Intelligence History
  • AML Services (Anti-Money Laundering)
    • PEP and Sanction Screening
      • Search using Name
        • Advanced Filters
      • Search using Identity
        • Advanced Filters
      • Search using Crypto
        • Advanced Filters
      • Retrieve a PEP and Sanction Screening Search
      • Screening Data Sources
      • Domestic PEP Search
    • Adverse Media Intelligence
    • Custom AML Watchlist
      • AML Watchlist (Sample list)
      • AML Watchlist Upload (Bulk Upload)
      • AML Watchlist Upload
      • Retrieve AML Watchlist
      • AML Watchlist Entity Update
      • AML Watchlist Entity Removal
  • Custom Workflow Builder (CWB)
    • CWB Webhook
    • CWB External API
      • Retrieve CWB History
      • Retrieve CWB Responses
      • Retrieve CWB Report
  • Youverify OS Error Codes
  • Webhooks
    • Know Your Customer Webhooks
      • Identity Verification
      • Address Verification
    • Know Your Transaction Webhooks
      • Customer Management Webhooks
        • Client Created
        • Client Updated
      • Alert Service Webhooks
        • Alert Created
        • Alert Triage Created
        • Alert Updated
      • Evaluation Webhooks
        • Evaluation Completed
        • Evaluation Started
        • Transaction Updated
  • Test Data
  • Our Legacy API and SDK
Powered by GitBook
On this page
  • Proof of Address Verification
  • Proof of Address Verification

Was this helpful?

  1. Know Your Customer Services (KYC)
  2. ID Data Matching (eIDV)
  3. South Africa

Proof of Address Verification

Proof of Address Verification

POST {{baseurl}}/v2/api/identity/za/poa

Headers

Name
Type
Description

token*

String

API secret token

Request Body

Name
Type
Description

id*

String

Users identity number

addressDetails*

Object

Address detail data object

proofOfAddressImage*

String

Proof of address image

address1*

String

Address line 1

address2*

String

Address line 2

suburb*

String

Suburban area

isSubjectConsent*

Boolean

Indicate subject has given consent. Must be true

houseNumber*

String

House number of candidate

street*

String

Street name of candidate

buildingName*

String

Candidates building name

unitName*

String

Candidates unit name

personalInformation*

Object

Validation data object

lastName*

String

Candidates last name

province*

String

Candidates province

city*

String

Candidates city

postalCode*

String

Candidates postal code

stateCode*

String

Candidates city code

duration*

String

Duration of stay

propertyType*

String

Candidates property type

country*

String

Candidates country

firstName*

String

Candidates first name

gender*

String

Candidates gender

email*

String

Candidates email address

idType*

String

Candidates ID type

Proof of Address Verification

With this endpoint, you have access to the verification of the client's proof of address in South Africa.

{
    "personalInformation": {
        "firstName": "JONAH",
        "lastName": "PILLAY",
        "gender": "M",
        "email": "XXXXX@XXXXX.com"
    },
    "addressDetails": {
        "proofOfAddressImage": "{{Base64String}}",
        "imageName": "image.jp",
        "address1": "Body Corporate of Cohiba",
        "address2": "Stand NO: 433",
        "suburb": "Radiokop",
        "houseNumber": "1",
        "street": "2",
        "buildingName": "2",
        "unitName": "2",
        "province": "2",
        "city": "Radiokop",
        "postalCode": "1752",
        "stateCode": "GP",
        "duration": "13",
        "propertyType": "O  ",
        "country": "ZA"
    },
    "id": "2502161858090",
    "idType": "SAID",
    "isSubjectConsent": true
}
{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "645bca7cd80de606cd7e5ad3",
        "validations": {
            "data": {
                "phoneNumber": {
                    "validated": false,
                    "value": "0795030317"
                },
                "fullName": {
                    "validated": true,
                    "value": "CONCO"
                },
                "email": {
                    "validated": false,
                    "value": "bonisiwez466@gmail.com"
                }
            },
            "validationMessages": "Email does not match, Phone Number does not match"
        },
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": true,
        "identityNumberValid": "No",
        "accountTypeValid": "Yes",
        "accountStatus": "Open",
        "acceptsDebits": "Yes",
        "acceptsCredits": "Yes",
        "accountNumberValid": "Yes",
        "{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "64cc3994d0ae9481b885e518",
        "parentId": null,
        "status": "found",
        "reason": null,
        "businessId": "62c2a4868d319373a6280152",
        "requestedAt": "2023-08-03T23:34:44.712Z",
        "requestedById": "62c2a4868d3193700828014e",
        "country": "ZA",
        "type": "zaPOA",
        "riskOutcome": "High",
        "isConsent": true,
        "metadata": {},
        "personalInformation": {
            "firstName": "JONAH",
            "lastName": "PILLAY",
            "gender": "M",
            "email": "XXXXX@XXXXX.com"
        },
        "addressDetails": {
            "proofOfAddressImage": "{{Base64String}}",
            "imageName": "image.jp",
            "address1": "Body Corporate of Cohiba",
            "address2": "Stand NO: 433",
            "suburb": "Radiokop",
            "houseNumber": "1",
            "street": "2",
            "buildingName": "2",
            "unitName": "2",
            "province": "2",
            "city": "Radiokop",
            "postalCode": "1752",
            "stateCode": "GP",
            "duration": "13",
            "propertyType": "O  ",
            "country": "ZA"
        },
        "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "62c2a4868d3193700828014e"
        }
    },
    "links": []
}
{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}
PreviousBank Account VerificationNextKenya

Last updated 9 months ago

Was this helpful?

πŸ‡ΏπŸ‡¦