Details of how to pull your user profile details are listed here.
\n","_postman_id":"cedb9b13-757e-4a2e-af84-fde36622965c","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"The query supports cursor-based pagination. Use the pageInfo.endCursor as the after: String parameter to retrieve the next pages.
Get category details, client contacts per contract.
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Use this query to retrieve all the information needed to create a screening case.\nThe query supports cursor-based pagination. Use the pageInfo.endCursor as the after: String parameter to retrieve the next pages.
The category has extendan ed configuration.
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"A Contract is a group of one of more Categories that will be charged on a single invoice. A Category is a package of screening checks that can be ordered for a candidate’s screening, making a Case. A Category can only appear on a single Contract, and an invoice can only contain one Contract. This section explains how to retrieve details of the Contract and Category information.
\n","_postman_id":"172f8b11-513d-4d50-89fa-9a01802061bc","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"The query supports cursor-based pagination. Use the pageInfo.endCursor as the after: String parameter to retrieve the next pages.
You can also jump to an arbitrary position by using the from parameter.
Use filters to search the screening cases.
\nThe query supports cursor-based pagination. Use the pageInfo.endCursor as the after: String parameter to retrieve the next pages.
You can also jump to an arbitrary position by using the from parameter.
Get the list of client questions that must be set during case creation.
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Create a screening case for a candidate.
\nField validation:
\n- \n
categoryId- mandatory, \nclientContactId- mandatory, \noptionalProductIds- optional, \njobTitle- mandatory, \nemploymentStart- optional, \nroleLocationScotland- optional, \ncandidate- mandatory:- \n
email- mandatory, \nfirstName- mandatory, \nlastName- mandatory, \nmiddleName- optional, \nphoneNumber- optional. \n
\n
Optional products
\nAll required products (those with \"required\": true) are created by default. If you want to enable optional products, add a list of IDs to the optionalProductIds field.
Example:\"optionalProductIds\": [\"{\"id\":42355,\"type\":\"ProductOption\"}\", \"{\"id\":42357,\"type\":\"ProductOption\"}\"]
Create a screening case if the client has questions.
\nField validation:
\n- \n
\ncategoryId- mandatory, \n
\nclientContactId- mandatory, \n
\noptionalProductIds- optional, \n
\njobTitle- mandatory, \n
\nemploymentStart- optional, \n
\nroleLocationScotland- optional, \n
\ncandidate- mandatory:- \n
\nemail- mandatory, \n
\nfirstName- mandatory, \n
\nlastName- mandatory, \n
\nmiddleName- optional, \n
\nphoneNumber- optional. \n
\n
Optional products
\nAll required products (those with \"required\": true) are created by default. If you want to enable optional products, add a list of IDs to the optionalProductIds field.
Example:\"optionalProductIds\": [\"{\"id\":42355,\"type\":\"ProductOption\"}\", \"{\"id\":42357,\"type\":\"ProductOption\"}\"]
Answer the questions
\nGet the list of questions in response to the \"Get client questions for category\" request, and place the answers in the \"answers\" input value.
\nWhen providing answers, you should specify the correct value type. For example, if the question expects an email, you should send a StringValue object, if a date range, a DateRange object. Find a field type per question in the \"Get client questions for category\" query (data -> category -> clientQuestions -> fields -> type) and use the corresponding answer field. Field can be mandatory or optional. Optional fields can be skipped in the request. Mandatory fields have data -> category -> clientQuestions -> fields -> required value as true.
The FieldValueInput input type snippet (the full GraphQL schema can be found in the Developer Portal):
input FieldValueInput {\n fieldId: ID!\n idValue: ID\n stringValue: String\n stringValues: [String!]\n booleanValue: Boolean\n floatValue: Float\n longValue: Long\n dateValue: Date\n dateRangeValue: DateRangeInput\n addressValue: AddressInput\n attachmentValue: AttachmentInput\n companyValue: CompanyInput\n countryValue: CountryInput\n qualificationsAndGradesValue: QualificationsAndGradesInput\n \"\"\"Sequential Upload parameter index, starting from 0\"\"\"\n uploadIndex: Int\n}\n\nUse the following mapping (the question field type maps to the FieldValueInput field name):
- \n
for
\nSTRING,EMAIL,PHONE_NUMBER,HIRING_MANAGER_EMAIL,LABEL,FIRST_NAME,SURNAME,COST_CENTER,NATIONAL_INSURANCE_NUMBER,PASSPORT,SELECT,DRIVING_LICENCE_NUMBER* => use thestringValuefield; \nfor
\nSELECT*,MULTIPLE_STRING=> use thestringValuesfield; \nfor
\nBOOLEAN,CONTACT_EMPLOYER=> use thebooleanValuefield; \nfor
\nINTEGER=> use thefloatValuefield; \nfor
\nADDRESS=> use theaddressValuefield; \nfor
\nUPLOAD=> use theuploadIndexfield that corresponding to theUploadelement in the rootcaseUpdatemutation; \nfor
\nCOMPANY=> use thecompanyValuefield; \nfor
\nCOUNTRY=> use thecountryValuefield; \nfor
\nDATE=> use thedateValuefield; \nfor
\nDATE_RANGE=> use thedateRangeValuefield; \nfor
\nQUALIFICATIONS_AND_GRADES=> use thequalificationsAndGradesValuefield. \n
** Notes on SELECT: The SELECT type can have two possible states:
- \n
Single Value: Use the
\nstringValuefield whenmultiSelect = false. \nMultiple Values: Use the
\nstringValuesfield whenmultiSelect = true. \n
To identify the configuration of a SELECT field, locate the field.restrictions in the response. For more details, please refer to the documentation here
For each selected option, only the value.id must be passed..
Create a screening case for a candidate with the attached file.\nNOTE: file upload for GraphQL requests may work incorrectly via Postman, use Altair or other alternatives for requests with attachments.
\nField validation:
\n- \n
categoryId- mandatory, \nclientContactId- mandatory, \noptionalProductIds- optional, \njobTitle- mandatory, \nemploymentStart- optional, \nroleLocationScotland- optional, \ncandidate- mandatory:- \n
email- mandatory, \nfirstName- mandatory, \nlastName- mandatory, \nmiddleName- optional, \nphoneNumber- optional. \n
\n
Optional products
\nAll required products (those with \"required\": true) are created by default. If you want to enable optional products, add a list of IDs to the optionalProductIds field.
Example:\"optionalProductIds\": [\"{\"id\":42355,\"type\":\"ProductOption\"}\", \"{\"id\":42357,\"type\":\"ProductOption\"}\"]
The case status can be one of:
\n- \n
ACTIVATED- the case is registered, \nCOMPLETED, \nCREATED- the case is initiated, \nDATA_REVIEW- data review by the screener, \nDATA_REVIEW_UNSUCCESSFUL- data review by the screener, \nDRAFT- start questionary, \nFAILED, \nINTERIM_CLEAR, \nPAUSED, \nWIP- in progress by the screener, \nWITHDRAWN_BY_CANDIDATE, \nWITHDRAWN_BY_CLIENT, \nWITHDRAWN_BY_INACTIVITY, \nWITHDRAWN_INTERNALLY- cancel Case for any reason. \n
The case product status can be one of:
\n- \n
ACTION_REQUIRED, \nAWAITING_3RD_PARTY, \nAWAITING_CANDIDATE, \nAWAITING_CLIENT, \nAWAITING_REFERENCE, \nCOMPLETED, \nFAILED, \nIRRELEVANT, \nREMOVED. \n
There are 2 types of notifications: SMS and email. The default notification type is OUTBOUND. The INBOUND type is used to mark the user's email reply.
The query supports cursor-based pagination. Use the pageInfo.endCursor as the after: String parameter to retrieve the next pages.
| \\n \\n \\n\\n \\n \\n\\n\\n\\n\\n \\n\\n \\n \\n\\n \\n \\n \\n\\n \\n \\n \\n\\n \\n \\n
\\n \\n\\n\\n \\n \\n \\n\\n \\n \\n\\n \\n \\n \\n\\n \\n \\n \\n\\n \\n \\n
| \\n
![\\\"Matrix](\\\"https://s3.amazonaws.com/unroll-images-production/projects%2F0%2F1601650038898-SW+logo.png\\\" "\\\\"Matrix")
\\n ![\\\"POA](\\\"https://unroll-images-production.s3.amazonaws.com/projects/0/1596578460712-Wrong%20way%20POA.png\\\" "\\\\"POA")
\\n \\n I have sent a reply to this message
From: VOLTi4 <info@securitywatchdog.org.uk>
Sent: Wednesday, August 9, 2023 2:12 PM
To: John Smith <johnsmith@example.com>
Subject: Message sent to user expected response
|
(Tracking ID: z6oHmlkBHW/KgwgwxuQymQ)
Update the candidate's screening case information. There are some steps where the candidate cannot be changed. You will receive an error if this is forbidden.
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Update the candidate's screening case information. There are some steps where the candidate cannot be changed. You will receive an error if this is forbidden.
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Field validation:
\n- \n
caseId- mandatory, \ncaseProductId- mandatory, \ntext- mandatory. \n
Ability for the client to trigger DVLA integration. Applicable for the rescreening case products configured with DVLA integration type. DVLA Integration details filed on a case product shows the status of the integration. Possible values are:
- \n
PENDING- integration is not triggered yet, \nSUCCESSFUL- integration is completed successfully, \nFAILED- integration completed with an error \n
It is possible to trigger integration again for the same product only if previous integration failed.
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"A Case is an ordered screening for a candidate, made against a Category of pre-defined checks, called Products. This section gives details of how to create a case, retrieve and make updates to the Case status and its Products, get Case information, and create and retrieve Notes (informative messages) on the Case.
\n","_postman_id":"bb47bc40-3984-492a-8118-e682c3b3485b","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Occasionally, a Case may be eligible for additional Products to be carried out, which generate additional Charges to be invoiced. Here are the methods for accessing the details of each Charge and approving or rejecting them.
\n","_postman_id":"afb555bf-24af-438c-9109-624622a6d3b6","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Allowed status values:
\n- \n
ACCEPTED, \nPENDING, \nREJECTED, \nREMOVED. \n
Risks are adverse results arising from a Product. The methods for accessing Risk details, and how to pass or fail a Risk, is described here.
\n⚠️ Please note: the API has changed:
\nThe alertId field is DEPRECATED.
Use alert { id } instead.
Migration: replace alertId with alert { id }.
Creates a new webhook subscription for a specified client, allowing you to configure the event type, callback URL, and authentication details. Use this mutation to register external endpoints that will receive event notifications from the system
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Updates the settings of an existing webhook subscription, except for the event type and client, which cannot be changed. Use this mutation to manage or reconfigure how event notifications are delivered to your endpoints.
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Deletes an existing webhook subscription by its ID, permanently removing it from the system. Use this mutation to stop receiving event notifications for the specified subscription
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Query all subscriptions for a client (or all available to the current user, if no clientId is specified).
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Get the list of all attachments. To find the entity they are linked to, use extended query.
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Fetch all attachments linked to the case, product, or answer entities.
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Allowed document types:
\n- \n
CERTIFICATE_OF_COMPLETION, \nCERTIFICATE_OF_GOOD_CONDUCT, \nCERTIFICATE_OF_INTERIM_CLEAR, \nCV, \nDECLARATION_OF_AUTHORITY, \nDRIVING_LICENCE, \nEDUCATION_PROFESSIONAL_QUALIFICATION_PROF, \nESSIONAL_MEMBERSHIP_CERTIFICATE, \nIDENTITY_DOCUMENT, \nIMPERIL__APPEAL_FORM, \nIMPERIL__DOCUMENTATION, \nIMPERIL__RISK_MATRIX, \nOTHER, \nPROOF_OF_ADDRESS, \nSIGNED_DECLARATION_OF_AUTHORITY, \nWORKAROUND_INFORMATION. \n
Download a ZIP archive with the attachments.
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Documents are saved along the lifecycle of a Case, from copies of ID, to results of Products, to the Certificate of Completion of Screening. They can be retrieved and uploaded, as well as downloaded as an archive, as described here.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"_postman_id":"09088823-0f58-4be0-a058-093320204e8a","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Returns the list of available countries.
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"This section lists the selectable options for all the various dictionaries used within a Case, such as country lists.
\n","_postman_id":"3a9a29d8-0d76-451a-9618-d7ad4f8eff47","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"In order to make successful API calls, you will need to generate an API key. You can use the API to create, retrieve, and remove your API keys, or they can be generated by Client Portal users with the right access levels. API keys are not assigned to a user (although one user can only have a maximum of 3 active keys) and can be shared with your backend service. Their lifespan is 2 months, so should be replaced regularly to prevent issues with authentication.
\n","_postman_id":"19b7d0fe-47f8-4f8c-aa45-e44cbdccec24","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Returns all available mutations with the input and return(payload) types.
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Returns all available queries with the input and return(payload) types.
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Returns the structure of specified payload type.
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Returns the structure of specified input type.
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Returns the list of values for specified enum type.
\n","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"Introspection allows to query information about a GraphQL schema - all available queries, mutations and object types. Similar to other queries, for authorization need to provide active OpenAPI Key.
\nDocumentation - https://graphql.org/learn/introspection/
\nAfter getting information about mutations/queries, use Get input details query to see input structure (you may need to use it recursively for complex types) and Get payload details query to see output structure. For enum type use Get enum values query to see all values.
\n","_postman_id":"b4251eeb-6144-4573-8a05-2d152ebe4772","auth":{"type":"apikey","apikey":{"value":"PUT_YOUR_API_KEY_HERE","key":"