Packages

Packages are collections of background screens, searches, and verifications used to create a report.

List all packages

Returns a list of available account packages for an account using the API token.

This list will be refreshed as new account packages are added or old ones are removed.
Use id from each package to order new reports or create invitations.
DO NOT USE package_id to order a report, this is a reference ID to the parent package in our database and is only to be used by Yardstik. Make sure you're always using the id instead, which is scoped to your account.

Defaults to listing all report packages. To get monitor packages, use the query param query[action_type_eq]=monitor

SecurityApiKey

Request

query Parameters

include_disabled	boolean Examples: lists all packages, including disabled ones include_disabled=true is the default value and only lists those that are enabled include_disabled=false
	object Examples: Filter by account packages that will generate a single report: query[action_type_eq]=report Filter by account packages that are used for continuous monitoring: query[action_type_eq]=monitor Filter by account packages that are used for certificate verification query[action_type_eq]=certificate

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/packages

Request samples

curl
Node.js
Ruby
Python
C#

Response samples

application/json

[{"id": "6b9f20bf-f2ff-45a4-916a-4112f4502c72",
"package_id": "04689d9c-a3c8-4b96-9662-53d972f14122",
"package": "Gold Standard 2",
"name": "test",
"package_system_name": "covid_screening",
"action_type": "monitor",
"screenings": [{"id": "3957b063-dcc8-4745-8300-dbd01a76f65d",
"name": "MVR",
"label": "MVR",
"screening_type": "MVR",
"intake_fields": [{"name": "driver_license_number",
"type": "string",
"label": "Driver License Number",
"required": true
}
]
}
],
"intake_fields": [{"name": "first_name",
"type": "string",
"label": "First Name",
"required": true
},
{"name": "middle_name",
"type": "string",
"label": "Last Name",
"required": false
},
{"name": "last_name",
"type": "string",
"label": "Last Name",
"required": true
}
]
},
{"id": "835086c3-3a41-41a5-8b97-f3406c424d76",
"package_id": "269a6069-5bd7-4b90-ae9b-ecdee7055daf",
"package": "Basic",
"name": "test",
"package_system_name": "covid_screening",
"action_type": "monitor",
"screenings": [{"id": "3957b063-dcc8-4745-8300-dbd01a76f65d",
"name": "CovidScreening",
"label": "Covid Screening",
"screening_type": "Certificate Verification",
"intake_fields": [{"name": "certificate_number",
"type": "string",
"label": "Certificate Number",
"required": true
}
]
}
],
"intake_fields": [{"name": "first_name",
"type": "string",
"label": "First Name",
"required": true
},
{"name": "middle_name",
"type": "string",
"label": "Last Name",
"required": false
},
{"name": "last_name",
"type": "string",
"label": "Last Name",
"required": true
}
]
}
]

➔ Next to Candidates