Create Form

POST 
/verification/api/1.0/ekyc-forms

Create Form

Request

application/json

Body

name string
purpose string
expiry number
verifications array
userPaymentRequired boolean
type string
sharing object

Responses

200

OK

application/json

Schema

Schema

code integer
message string
data object

Example (from schema)

{
  "code": 0,
  "message": "string",
  "data": {}
}

Valid

{
  "code": 0,
  "message": "Success",
  "data": {
    "_id": "664dc505f7675bad1a822371",
    "name": "Demo form 2",
    "purpose": "657ab9ba7c8741f1f8bc3376",
    "expiry": 1717093800,
    "verificationList": [
      {
        "name": "bgv-degree",
        "mode": "manual",
        "skipAllowed": true,
        "marksheetRequired": false
      },
      {
        "name": "bgv-employment",
        "mode": "manual",
        "skipAllowed": true
      },
      {
        "name": "bgv-twelfth",
        "mode": "manual",
        "skipAllowed": true
      }
    ],
    "sharing": {
      "mode": []
    },
    "archived": false,
    "type": "diy",
    "userPaymentRequired": false,
    "createdAt": "2024-05-22T10:12:21.702Z",
    "updatedAt": "2024-05-22T10:12:21.702Z"
  }
}

Invalid

{
  "message": "Error message",
  "code": -1
}

Loading...