📘
POST
https://api.prembly.com/background-check/api/v1/package
Key | Value | Description |
---|
x-api-key | API Key | Your live secret key |
Key | Value | Description |
---|
name | | Name of the package |
purpose | | A description of what you can remember the package by |
check_type | | IDs of selected checks gotten from "Get All Available Checks" |
check_type_attribute | | "Endpoint" of verification under selected check |
face_capture | | Enable or disable face capture |
country | | Package country {e.g NG. KE. GH etc} |
{
"status": true,
"status_code": "00",
"detail": "Package created successfully"
Response | Description |
---|
status | When status is true, the API call was successful |
status_code | Status of the response |
detail | A notification indicating a successfully created package |