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
    • KYB Bulk Upload
    • 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
  • Credit Report
    • πŸ‡¬πŸ‡§UK Business Credit Report
  • 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

Was this helpful?

  1. Custom Workflow Builder (CWB)
  2. CWB External API

Retrieve CWB History

This endpoint returns your CWB history and can be filtered by start and end dates, as well as title.

GET {{baseurl}}/v2/api/v-forms/

Query Parameters

Name
Type
Description

page

Number

Page number of pagination

limit

Number

Limit of results to retrieve

startDate

Date

Filter Results by startDate, it requires a corresponding endDate. Both must be in YYYY-MM-DD format

endDate

Date

Filter Results by endDate, it requires a corresponding startDate. Both must be in YYYY-MM-DD format

title

String

Fileter results by VForm Title

Headers

Name
Type
Description

token*

String

API secret token

{
    "success": true,
    "statusCode": 200,
    "message": "Results retrieved",
    "data": {
        "docs": [
            {
                "id": "6388737f79b3176be7eae374",
                "title": "test",
                "entries": 0,
                "allowedEntries": null,
                "createdAt": "2022-12-01T09:27:27.655Z",
                "updatedAt": "2022-12-01T09:27:27.655Z",
                "userId": "62b2e8b381442b75857f7898",
                "businessId": "62b2e8b281442b03187f7896",
                "isHidden": false,
                "status": "draft",
                "templateType": "RegularVFormTemplate",
                "last3Users": [],
                "user": {
                    "firstName": "Abdulazeez",
                    "lastName": "Shittu",
                    "middleName": "",
                    "email": "abdulazeez@youverify.co",
                    "mobile": "+2348034319159",
                    "countryCode": "NG",
                    "id": "62b2e8b381442b75857f7898"
                }
            },
            {
                "id": "6368a5ce75d8197615700ff1",
                "title": "check",
                "entries": 6,
                "allowedEntries": null,
                "createdAt": "2022-11-07T06:29:34.769Z",
                "updatedAt": "2022-11-07T06:29:34.769Z",
                "userId": "62b2e8b381442b75857f7898",
                "businessId": "62b2e8b281442b03187f7896",
                "isHidden": false,
                "status": "published",
                "templateType": "RegularVFormTemplate",
                "last3Users": [
                    {
                        "firstName": "shittu",
                        "lastName": "name"
                    },
                    {
                        "firstName": "test",
                        "lastName": "me"
                    },
                    {
                        "firstName": "me",
                        "lastName": "shittu"
                    }
                ],
                "user": {
                    "firstName": "Abdulazeez",
                    "lastName": "Shittu",
                    "middleName": "",
                    "email": "abdulazeez@youverify.co",
                    "mobile": "+2348034319159",
                    "countryCode": "NG",
                    "id": "62b2e8b381442b75857f7898"
                }
            },
        ],
        "pagination": {
            "totalDocs": 2,
            "perPage": 20,
            "page": 1,
            "totalPages": 1,
            "serialNo": 1,
            "hasPrevPage": false,
            "hasNextPage": false,
            "prevPage": null,
            "nextPage": null,
            "currentPage": 1
        }
    },
    "links": []
}
Attribute
Type
Description

id

String

vForm's template object unique identifier.

businessId

String

This is the unique identifier of the business that created the vForm.

userId

String

This is the unique identifier of the user that created the vForm ,a vForm business can have multiple users

title

String

The vForm template title

user

Object

This object contains details about the form template owner

-- firstname

String

form template owner's first name

-- lastname

Integer

form template owner's last name

-- middlename

String

form template owner's middle name

-- mobile

String

form template owner's mobile number

-- email

String

form template owner's email

-- countryCode

String

form template owner's country code

-- id

String

same as userId

last3Users

Array of Objects

This contains three or less objects that is made up of the last three form filler's first name and last name.

entries

Integer

The total number of submissions for this form template.

createdAt

String(date)

The date this template was created.

updatedAt

String(date)

The date this template was last updated.

status

String

This is the overall status of the vForm template, which can be anyone of the following

"draft": a form template that has not but published "published": a form template that has been published "unpublished": a form template that has been unpublished "archived": a form template that was meant to be deleted but was archived because it contains a/some response(s)

PreviousCWB External APINextRetrieve CWB Responses

Last updated 11 months ago

Was this helpful?