Prembly
GuidesAPI Reference
Background ChecksReportsGet report customization GET
GET
/api/v1/api/bgc/report-customization/

Returns how your organisation's background check reports are branded and laid out. Defaults are returned when you have never saved any.

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Response Body

application/json

curl -X GET "https://example.com/api/v1/api/bgc/report-customization/"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",    "logo": "http://example.com",    "company_name": "string",    "primary_color": "string",    "secondary_color": "string",    "accent_color": "string",    "text_color": "string",    "header_text": "string",    "footer_text": "string",    "show_company_address": true,    "show_company_contact": true,    "show_watermark": true,    "watermark_text": "string",    "show_verification_summary": true,    "show_check_details": true,    "show_candidate_info": true,    "show_timestamps": true,    "introduction_message": "string",    "disclaimer_message": "string",    "template_style": "modern",    "font_family": "string",    "font_size": "string",    "custom_css": "string",    "additional_settings": null,    "effective_logo": "string",    "effective_company_name": "string",    "color_scheme": "string",    "visibility_settings": "string",    "is_active": true,    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  },  "status": true,  "message": "Request successful.",  "errors": {},  "meta": {    "timestamp": "2019-08-24T14:15:22Z",    "version": "v1",    "request_id": "string"  },  "pagination": {    "page": 0,    "page_size": 0,    "total_pages": 0,    "total_items": 0  }}
Response Codes & Statuses: Prembly API responses include custom response_code values (e.g., 00 Success, 01 Not Found, 02 Unavailable).
View Response Codes Guide
Prembly Slack Community

Join our developer Slack channel for real-time integration support, engineering updates, and direct Q&A with the Prembly team.

Join Slack Channel

Initialize candidate payment POST

Starts payment for a request where the candidate, rather than your organisation, is paying. Returns an authorization URL to redirect the candidate to. The request stays in `pending_payment` until the gateway confirms.

Save report customization POST

Saves your report branding and layout, creating the settings if none exist and replacing them if they do. Applies to reports generated from now on; reports already produced are unchanged. `PUT` and `PATCH` on this path do exactly the same thing and are kept only for existing callers.