Create Package

📘

POST

https://api.prembly.com/background-check/api/v1/package

REQUEST HEADER

KeyValueDescription
x-api-keyAPI KeyYour live secret key

REQUEST BODY

KeyValueDescription
nameName of the package
purposeA description of what you can remember the package by
check_typeIDs of selected checks gotten from "Get All Available Checks"
check_type_attribute"Endpoint" of verification under selected check
face_captureEnable or disable face capture
countryPackage country {e.g NG. KE. GH etc}

RESPONSE

{
    "status": true,
    "status_code": "00",
    "detail": "Package created successfully"

RESPONSE DESCRIPTION

ResponseDescription
statusWhen status is true, the API call was successful
status_codeStatus of the response
detailA notification indicating a successfully created package