![\"Developer](\"http://api.sterlingtalentsolutions.com/wp-content/uploads/2020/02/dev-portal.png\")
The Sterling API allows you to integrate background checks into your platform and manage the process from end-to-end.
\nUsing the Sterling API, you can build applications that:
\nAccess to the Sterling API can be requested from our Developer Signup page. Once you receive your Client ID and Client Secret, here are the steps that API users typically follow to consume the Sterling APIs and perform end-to-end testing on your own.
\nStep 1: Get Authentication
\nStep 2: GET /packages
\nStep 3: POST /candidates
\nStep 4: POST /screenings
\nStep 5: Process screenings using the Developer Portal
\nStep 6: Verify callbacks
\nRequired Fields & Data Collection
\n\n\nNote: You’ll want to consider the required candidate fields so that you can design your application to collect the pertinent information.
\nInvite Feature: If you don't want to collect all of the required candidate information then the alternative is to have Sterling handle the data collection. To use this feature, set the attribute
\ninvite.methodto\"email\"to send the candidate an email, or setinvite.methodto\"link\"to receive the form URL within the API response when you callPOST /screenings.
Going Live
\n\n\nWhen going live, be sure to switch your host endpoint to the production environment. This will also require you to obtain authentication credentials for that environment.
\n
The Sterling API uses OAuth2 for authorization and authentication.
\nRequests to the Sterling API must be authenticated using short-lived bearer token in the Authorization header. Applications will obtain bearer tokens via the oauth endpoint:
cURL
\ncurl -X POST -H \"Authorization: Basic <basic auth token>\" \\\n-H 'Content-Type: application/x-www-form-urlencoded' \\\n-d 'grant_type=client_credentials' \\\nhttps://api.us.int.sterlingcheck.app/oauth/token\nWhen making a request to the oauth endpoint, the basic auth credentials must be a base64 encoded string in the format client_id:client_secret. These credentials are not provided through the API and must be obtained through Sterling.
Base64
\n\n\nThe base64 encoded string for the credentials will remain unchanged unless your client_secret is changed at your request.
\nFor instance,
\nexample@example.com:86753O9will always encode asZXhhbXBsZUBleGFtcGxlLmNvbTo4Njc1M085.
If the provided credentials are valid, the oauth endpoint will provide a bearer token, along with an expiry time for the token (in seconds). An access_token will expire after 10 hours.
\nJSON
\n{\n \"access_token\": \"RG8gcGVvcGxlIHJlYWxseSBkZWNvZGUgdGhlc2U/IEkgbWVhbiBzZXJpb3VzbHksIHRoaXMgaXMganVzdCBhIHRlc3QgaGFzaCEgV2VsbCwgaWYgeW91IG1hZGUgaXQgdGhpcyBmYXIsIGFsbG93IG1lIHRvIHJld2FyZCB5b3U6DQoNCmh0dHBzOi8vd3d3LnlvdXR1YmUuY29tL3dhdGNoP3Y9ZFF3NHc5V2dYY1E=\",\n \"token_type\": \"bearer\",\n \"expires_in\": 36000\n}\nThis token should be cached until it expires, and must be passed in the Authorization header of each request as follows:
cURL
\ncurl -H \"Authorization: Bearer RG8gcGVvcGxlIHJlYWxseSBkZWNvZGUgdGhlc2U/IEkgbWVhbiBzZXJpb3VzbHksIHRoaXMgaXMganVzdCBhIHRlc3QgaGFzaCEgV2VsbCwgaWYgeW91IG1hZGUgaXQgdGhpcyBmYXIsIGFsbG93IG1lIHRvIHJld2FyZCB5b3U6DQoNCmh0dHBzOi8vd3d3LnlvdXR1YmUuY29tL3dhdGNoP3Y9ZFF3NHc5V2dYY1E=\" \\\n-H \"Accept: application/json\" \\ \nhttps://api.us.int.sterlingcheck.app/v1/candidates/7212643\n500 Errors
\n\n\nIf you receive a 500 error on any API call using an Authorization header, please check that the format is \"Bearer [base64]\".
\n
Sterling provides a Developer Portal to facilitate testing integrations and ensure all potential workflows are taken into account. Within the Dev Portal you can see all of your submitted screenings, as well as change their statuses.
\n\n\nThe Dev Portal's functionality is specific to Sterling's test environment. You can log in with your client ID and secret once we have provisioned a test account and provided those credentials to you.
\n
Background screenings involve gathering information from a variety of public and proprietary records, and as a result the response times for screenings can be unpredictable. As an API user, you can receive notifications when important events related to your screening occur. To receive update notifications, include a callback when creating a screening or subscription.
The callback type field supports future extensibility. At present, all callbacks are of the screening type.
Additional callback types may be introduced in the future. These new callback types will follow the same pattern as existing callbacks: the callback url will be specified in the POST request for the resource. This means that you are free to create one callback handling service exclusively for screenings and other services for each other callback type.
Alternatively, clients may implement a single general-purpose callback handler for all Sterling API callbacks. In that situation, the callback handler can use the type field to identify the message type and ensure that the intended parsing or business rules are applied only to the expected message types.
Retries
\n\n\nCallbacks will retry every 15 minutes until an HTTP 200 success response is returned from your server. The retries will attempt 9 more times after the original (for a total of 10 attempts).
\n
Screening Callbacks
\nThe most common callback type will be a screening, as it is the object that will receive the most changes over time. A sample JSON payload for a screening callback can be seen below.
JSON
\n{\n \"type\": \"screening\",\n \"payload\": {\n \"id\": \"001000063194810\",\n \"packageId\": \"101337\",\n \"candidateId\": \"8675309\",\n \"status\": \"complete\",\n \"result\": \"alert\",\n \"reportItems\": [\n {\n \"id\": \"62113371\",\n \"type\": \"Multi-State Instant Criminal Check\",\n \"status\": \"complete\",\n \"result\": \"no data\",\n \"updatedAt\": \"2016-07-08T21:42:46Z\"\n },\n {\n \"id\": \"62113372\",\n \"type\": \"Nationwide Sex Offender Registry Check\",\n \"status\": \"complete\",\n \"result\": \"alert\",\n \"updatedAt\": \"2016-07-08T21:42:46Z\"\n }\n ],\n \"submittedAt\": \"2017-04-26T20:41:27Z\",\n \"updatedAt\": \"2017-04-26T20:42:16Z\",\n \"dispute\": {\n \"status\": \"active\",\n \"createdAt\": \"2017-04-26T20:41:27Z\"\n },\n \"links\": {\n \"admin\": {\n \"web\": \"https://integration.talentwise.com/screening/report.php?ApplicantID=63194810\",\n \"pdf\": \"https://integration.talentwise.com/screening/pdf-report.php?ApplicantID=63194810\"\n }\n },\n \"adverseActions\": [\n {\n \"id\": \"001000063194810\",\n \"status\": \"awaiting-dispute\",\n \"updatedAt\": \"2017-04-26T20:41:27Z\",\n \"reportItemIds\": [\n \"62113372\"\n ]\n }\n ]\n }\n}\nCallback Statuses
\nEvery screening callback will have a status property in its payload. The value of status will change depending on the status of each item in reportItems.
Package(Payload) Statuses
\nReport Results
\nA report's result property will give a more detailed description of the response.
Report Statuses
\nEach individual report may have their own statuses and these will vary upon the type of report processed.
\nIf using these statuses, it's best practice to only concern yourself with the most common values. Here's a list of the top common report status values.
\nCallback Consumption
\n\n\nCallbacks from the Sterling API support data consumption in chunked and non-chunked variants. Chunking is possible when the callback payload data exceeds 1MB in size.
\n
The Sterling API supports the use of an idempotency-key in your screening requests, which allows you to safely retry these requests without accidentally performing the same operation twice. This is helpful if there are networking issues and you wanted to guarantee that you do not create duplicate screenings.
An idempotency key can be unique value of your choice and how you create these keys is up to you. To avoid collisions within your own account, try using unpredictable string values or a random V4 UUID.
\nIf a screening request fails when using the idempotency-key, retry using the same key value in order to guarantee that only one screening is created.
Key Expiration
\n\n\nAny value used as an idempotency key to successfully create a new screening may be reused for 24 hours after it is successfully associated with a screening record. Retrying screening attempts using the same key will not reset the expiration date and will continue to return the same screening associated with that key until the 24 hour expiration window is met. After the 24 hour window has passed, a new screening can and will be created with the same idempotency key.
\n
cURL
\ncurl -X POST 'https://api.us.int.sterlingcheck.app/v1/screenings' \\\n-H \"Authorization: Bearer <access token>\" \\\n-H 'Content-Type: application/json' \\\n-H 'idempotency-key: \"ccf492f0-231a-45eb-bc29-8e3687445715\"' \\\n-d '{\n \"packageId\": \"96193\",\n \"candidateId\": \"001c8b73-4b0d-4dac-bcc0-479bf91f222a\" \n}'\nSterling uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate a success, codes in the 4xx range indicate a request that failed given the information provided (e.g. a required parameter was omitted, format issues, etc.), and codes in the 5xx range indicate an error with Sterling's servers.
When a request is valid but does not complete successfully, we return a 400# error code. Below you'll find more detailed information about the possible errors you can expect.
The expected format for an error is as follows:
\n{\n \"errors\": [\n {\n \"code\": \"400#[optional-object]?[optional-reason]\",\n \"message\": \"[optional-message]\"\n }\n ]\n}\nError Code Format
\nError Message Format
\n\"message\": \"dob must be in the format of YYYY-MM-DD\")Example:
\n{\n \"errors\": [\n {\n \"code\": \"400#dob?format\",\n \"message\": \"dob must be in the format of YYYY-MM-DD\"\n }\n ]\n}\n\n\nSince the error
\nmessagecan change from time to time, we highly recommend you key off of the errorcodeif you plan implement any automation for errors.
Required Fields
\nExamples
\nError Message
\n{\n \"errors\": [\n {\n \"code\": \"400#givenName\",\n \"message\": \"givenName is required\"\n }\n ]\n}\nSolution
\nInclude the \"givenName\" field in the candidate object:
\n{\n //...\n \"givenName\": \"John\",\n //...\n}\nError Message
\n{\n \"errors\": [\n {\n \"code\": \"400#address.addressLine\",\n \"message\": \"if address is provided, addressLine is required\"\n }\n ]\n}\nSolution
\nIn the \"address\" sub-object, include an \"addressLine\" field:
\n{\n //...\n \"givenName\": \"John\",\n //..\n \"address\": {\n \"addressLine\": \"123 Example Street\",\n \"municipality\": \"ATLANTA\",\n //..\n }\n}\nWe hold ourselves to a high standard – and part of that means continuing to provide quality service to all customers. In order to make this is possible, the Sterling API is rate limited.
\nIf the rate limit is exceeded for the specified endpoint in your request, the API will respond with a 429 Too Many Requests status code.
Below is a table of the rate limiting thresholds for the most used endpoints:
\nThere are several ways you can help control the amount of requests you make within limits:
\nIf you believe there is a possibility that the limits could be exceeded, it is advised that you use exponential backoff logic to retry the requests.
\nIf processing a large batch of requests, you could implement a delay between requests.
\nCheck your existing workflow for duplicate or unnecessary API requests. A common example would be making numerous authentication requests when an access token is already valid for the next 10 hours.
\nCreate a webhook or use callbacks to receive real-time updates about a report instead of retrieving them in batches.
\nThis document describes Sterling API version 1. The Sterling API follows semantic versioning, which means that we are committed to maintaining this API without breaking changes. The Sterling API considers any removal or renaming of an API endpoint or JSON field from an API response to be a breaking change. Additions of new required input fields would also be incompatible with existing client code, so any newly-added input fields will always be optional.
\nAlthough fields will not be removed from responses, fields may be added to introduce new capabilities. Applications consuming this API should use permissive deserialization techniques when parsing JSON responses. It will always be safe to ignore unrecognized, optional fields.
\nExample of Permissive Deserialization
\n\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"},{"content":"Authentication","slug":"authentication"},{"content":"Developer Portal","slug":"developer-portal"},{"content":"Callbacks","slug":"callbacks"},{"content":"Idempotency","slug":"idempotency"},{"content":"Errors","slug":"errors"},{"content":"Versioning","slug":"versioning"}],"owner":"902667","collectionId":"9b53fca1-0578-4596-97ba-14daa47e54da","publishedId":"S1Lr5BHV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303F49","highlight":"FF2C00"},"publishDate":"2021-01-30T00:03:37.000Z"},"item":[{"name":"API Endpoints","item":[{"name":"Auth","item":[{"name":"Generate Access Token","event":[{"listen":"test","script":{"id":"c7868082-53bb-4ade-9bc6-9479778bd778","exec":["var jsonData = JSON.parse(responseBody);","tests[\"jwt token valid\"] = !!jsonData.access_token;","","postman.setGlobalVariable(\"bearer_token\", jsonData.access_token);"],"type":"text/javascript"}}],"id":"f41467db-aa77-413f-9fe4-023dd026ba6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"BasicWhen using the Jackson JSON parsing library for Java, clients should disable the
\nDeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIESflag.
cURL
\ncurl -X POST \\\n-H \"Authorization: Basic <basic auth token>\" \\\n-H 'Content-Type: application/x-www-form-urlencoded' \\\n-d 'grant_type=client_credentials' \\\nhttps://api.us.int.sterlingcheck.app/oauth/token\nWhen making a request to the oauth endpoint, the basic auth credentials must be a base64 encoded string in the format client_id:client_secret. These credentials are not provided through the API and must be obtained through Sterling.
Return a list of all available packages.
\n","urlObject":{"path":["v1","packages"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"99882a5b-a07c-4d43-b8a3-a05dde6a1cd0","name":"List All Packages","originalRequest":{"method":"GET","header":[],"url":"{{host}}/v1/packages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"9206"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 01 May 2019 23:35:36 GMT"},{"key":"x-amzn-RequestId","value":"d0f53f44-6c69-11e9-8cc0-d321f373349e"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZBwDAGHDIAMFwkg="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5cca2d46-ecd78fd0bd996ad0b9a05452;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c772176b119045d2ed52ef4f42db5fe0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"tdEVH8xl_wcjgZewbAbhpUxvMkG7vv-XWqJo6hzYBlNyOsoEs8xmIw=="}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"1234\",\n \"title\": \"My Screening Package\",\n \"active\": true,\n \"type\": \"invoice-billing\",\n \"components\": [\n \"SSN Trace\",\n \"Criminal County Search (7-Year Address History)\",\n \"Federal Criminal Check\",\n \"Multi-State Instant Criminal Check With Verification\",\n \"Nationwide Sex Offender Registry Check\"\n ],\n \"requiredFields\": [\n \"address.addressLine\",\n \"dob\",\n \"familyName\",\n \"givenName\",\n \"ssn\",\n \"address.postalCode\"\n ]\n },...\n]"}],"_postman_id":"68d6db52-0d8e-4e0d-8636-870087defe39"},{"name":"Package Price","id":"d83f35df-b7c0-4d41-ba7a-b699a507fdc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}","type":"text"}],"url":"{{host}}/v1/packages/{package_id}/price?candidateId={{candidate_id}}","description":"Return the price of a screening based on the package id and candidateId provided.
candidate id you are looking to price
\n","type":"text/plain"},"key":"candidateId","value":"{{candidate_id}}"}],"variable":[]}},"response":[{"id":"342bcbab-dbfc-47c3-814a-9579c7eba42d","name":"Candidate Missing Fields","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{host}}/v1/packages/8398190/price?candidateId=1234","host":["{{host}}"],"path":["v1","packages","8398190","price"],"query":[{"key":"candidateId","value":"1234","description":"candidate id you are looking to price"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"34"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 May 2019 17:57:37 GMT"},{"key":"x-amzn-RequestId","value":"bfc3089e-6d03-11e9-9750-f5a11648ff7e"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZERdRGvooAMFdIw="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccb2f88-7f2b4948f4bd753860242a84"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 2d5ae77baf1e996b29b17b6541abf9c2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"ELW9uRmtZckcYkBxz6f2uZQdi9OIM8cIHaXiNybjD4UXNIXXaMvXnA=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400#candidate?required-fields=address.addressLine\",\n \"message\": \"Candidate {{id}} is missing required field for package {{id}}: address.addressLine.\"\n },\n {\n \"code\": \"400#candidate?required-fields=dob\",\n \"message\": \"Candidate {{id}} is missing required field for package {{id}}: dob.\"\n },\n {\n \"code\": \"400#candidate?required-fields=ssn\",\n \"message\": \"Candidate {{id}} is missing required field for package {{id}}: ssn.\"\n },\n {\n \"code\": \"400#candidate?required-fields=address.postalCode\",\n \"message\": \"Candidate {{id}} is missing required field for package {{id}}: address.postalCode.\"\n }\n ]\n}"},{"id":"4562de08-36c6-494e-9c57-079f57abae58","name":"Get Package Price","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v1/packages/8398190/price?candidateId=988638140","host":["{{host}}"],"path":["v1","packages","8398190","price"],"query":[{"key":"candidateId","value":"988638140","description":"candidate id you are looking to price"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"34"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 01 May 2019 23:44:56 GMT"},{"key":"x-amzn-RequestId","value":"115ba630-6c6b-11e9-8f4c-613eedb249c4"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZBxXAELBoAMFRsA="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5cca2f60-b3f62d081e7eab84370ff500"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 5f96bc4a22f6baa91bf4a4bb246e4ff9.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"LgM5NH4xDoZK-dN36Al6eK5HFc8OJSY5SAgMch7Sipro57lpfK-gkA=="}],"cookie":[],"responseTime":null,"body":"{\n \"currencyType\": \"USD\",\n \"total\": 195.16\n}"},{"id":"98787ab2-a58b-4861-9b60-9ea3c5ed668e","name":"Invalid Candidate","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{host}}/v1/packages/8398190/price?candidateId=1234","host":["{{host}}"],"path":["v1","packages","8398190","price"],"query":[{"key":"candidateId","value":"1234","description":"candidate id you are looking to price"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"143"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 May 2019 17:50:28 GMT"},{"key":"x-amzn-RequestId","value":"bfb4f3ad-6d02-11e9-af29-5b8c3dfaf9ef"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZEQaJEAfIAMFkfg="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccb2dda-ce9ec09b76685087bfa439a0;Sampled=0"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 2d5ae77baf1e996b29b17b6541abf9c2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"5YRcc4KaXdfiE9sMJBQun5FlP0MW1ypPhxkNffcYDTCR6y3lQfA2Lg=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400#candidateId?not-found\",\n \"message\": \"candidateId must be a valid candidateId associated with the authenticated account\"\n }\n ]\n}"}],"_postman_id":"d83f35df-b7c0-4d41-ba7a-b699a507fdc2"}],"id":"e280e604-371b-4085-bb58-63fbf13149b7","description":"A \"package\" is essentially a container for products/screenings. You can think of packages as your team's predefined background screening recipes. The Sterling API provides a number of components, which are individual searches that can be bundled up into a single package. Common components do things like check driving records or criminal records in various jurisdictions (like count, state, or federal courts). Packages are unique to your account and are used to standardize the checks your account uses to screen individuals based on your company or organization's needs.
A GET on the /packages endpoint provides a list of the packages defined for your account. The package response also lists the required candidate fields needed to initiate a screening with the package. Some components require more candidate data than others to successfully discover records related to the candidate, which means that different packages will have different required fields.
Creates a new candidate record.
\nThe minimum required fields for any given candidate may differ depending on package that has been chosen. The best way to ensure that you are collecting all the data you need from your candidates is to look up the list of requiredFields using the Packages resource.
If you plan on using the Sterling Data Collection flow, the only required fields the candidate will need are:
\ngivenNamefamilyNameemailclientReferenceId\n\nThe candidate's
\nclientReferenceIdmust be unique. If you'd like to reuse an email, you could consider updating the existing candidate using the email to a new value.
In addition to the required fields above, new screening requests using the Client-Side Data Collection flow may need to provide:
\nssndobaddressaddressLinemunicipalitypostalCodecountryCoderegionCodeThe fields required to create a new screening with MVR are:
\ndriversLicensetypelicenseNumberissuingAgencyAside from formatting, the required fields are validated when you make a new screening request. The package requirements will be used to validate that all the required fields are provided on the candidate.
\nRequest Body Fields
\n","urlObject":{"path":["v1","candidates"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"8d404be7-3fc2-471f-8ebd-40bf543f18f6","name":"Missing Required Field","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientReferenceId\": \"093ecfa6-493a-4e6e-9122-072f917d5e9g\",\n \"confirmedNoMiddleName\": true,\n \"familyName\": \"Doe\",\n \"email\": \"john-test@example.com\"\n}"},"url":"{{host}}/v1/candidates"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"71"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 May 2019 17:46:37 GMT"},{"key":"x-amzn-RequestId","value":"35b53182-6d02-11e9-8eee-b9acf6a61e55"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZEP19Fl_oAMFcxA="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccb2cf2-11a752bda84b12f17e948423"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 2d5ae77baf1e996b29b17b6541abf9c2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"BW4FT3Vv0Godd586tsZ3hhxDRKKNcCHiSXR2HF72G3idHCQMSOZMhw=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400#givenName\",\n \"message\": \"givenName is required\"\n }\n ]\n}"},{"id":"99b02155-b5a2-4e5b-b5ec-35b758ec4f42","name":"Using Existing Fields","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientReferenceId\": \"093ecfa6-493a-4e6e-9122-072f917d5e9f\",\n \"givenName\": \"John\",\n \"confirmedNoMiddleName\": true,\n \"familyName\": \"Doe\",\n \"email\": \"john-test@example.com\"\n}"},"url":"{{host}}/v1/candidates"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"174"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 May 2019 17:42:39 GMT"},{"key":"x-amzn-RequestId","value":"aaedb264-6d01-11e9-8eac-512b971607ab"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZEPRlFXjoAMFlHg="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccb2c0a-36a1b13fb9a42fb1c4b48657;Sampled=0"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 2d5ae77baf1e996b29b17b6541abf9c2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"WXRBlY1bi25KSaKQIObwh7ki8nFBcyVlSBiyaj6r4HYkbEX_KcxXnA=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"409#clientReferenceId?already-in-use\",\n \"message\": \"clientReferenceId already in use\"\n },\n {\n \"code\": \"409#email?already-in-use\",\n \"message\": \"email already in use\"\n }\n ]\n}"},{"id":"bcdf2495-0188-4cc4-b4d0-4dddddf554d4","name":"Create Candidate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"body":{"mode":"raw","raw":"{\n \"clientReferenceId\": \"e4e1ffda-caa3-ea6d-c095-be8429b31154\",\n \"givenName\": \"John\",\n \"confirmedNoMiddleName\": true,\n \"familyName\": \"Doe\",\n \"dob\": \"1998-07-18\",\n \"email\": \"john-test@example.com\",\n \"phone\": \"+14041231234\",\n \"ssn\": \"123456789\",\n \"address\": {\n \"addressLine\": \"123 Sterling Street\",\n \"municipality\": \"Bellevue\",\n \"regionCode\": \"US-WA\",\n \"postalCode\": \"98011\",\n \"countryCode\": \"US\"\n },\n \"driversLicense\": {\n \"type\": \"personal\",\n \"licenseNumber\": \"S1234567\",\n \"issuingAgency\": \"CA\"\n },\n \"aliases\": [{\n \"givenName\": \"Robert\",\n \"familyName\": \"Saur\",\n \"middleName\": \"William\",\n \"confirmedNoMiddleName\": false \n },{\n \"givenName\": \"Simon\",\n \"familyName\": \"Duck\",\n \"confirmedNoMiddleName\": true\n }]\n }"},"url":"{{host}}/v1/candidates"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"653"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 May 2019 16:24:09 GMT"},{"key":"x-amzn-RequestId","value":"b088caa9-6cf6-11e9-aca2-15319877eb1c"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZEDw3HCJoAMFvEA="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccb199f-d0407ba07437fbd8b524fbc0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 1019c7748e9bd9371b8cbc3777f0a40e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"_8t3AeHIaXkmdZ2Ydtmj1BcLnDFOWMi6Va5I2eDXgBzShXr9ZCI79g=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"988293912\",\n \"clientReferenceId\": \"e4e1ffda-caa3-ea6d-c095-be8429b31154\",\n \"email\": \"john-test@example.com\",\n \"givenName\": \"John\",\n \"familyName\": \"Doe\",\n \"confirmedNoMiddleName\": true,\n \"dob\": \"1998-07-18\",\n \"ssn\": \"123456789\",\n \"phone\": \"+14041231234\",\n \"address\": {\n \"addressLine\": \"123 Sterling Street\",\n \"municipality\": \"Bellevue\",\n \"regionCode\": \"US-WA\",\n \"postalCode\": \"98011\",\n \"countryCode\": \"US\"\n },\n \"aliases\": [\n {\n \"givenName\": \"Robert\",\n \"familyName\": \"Saur\",\n \"middleName\": \"William\",\n \"confirmedNoMiddleName\": false\n },\n {\n \"givenName\": \"Simon\",\n \"familyName\": \"Duck\",\n \"confirmedNoMiddleName\": true\n }\n ],\n \"screeningIds\": [],\n \"driversLicense\": {\n \"type\": \"personal\",\n \"licenseNumber\": \"S1234567\",\n \"issuingAgency\": \"CA\"\n }\n}"}],"_postman_id":"86ffcfa1-a703-4819-9d90-da0c1e8b1a8a"},{"name":"Update Candidate","event":[{"listen":"test","script":{"id":"27ecd530-4f3d-4fec-b548-e9accaa1abc3","exec":["var jsonData = JSON.parse(responseBody);","tests[\"Status code is 200\"] = responseCode.code === 200;","","postman.setGlobalVariable(\"email\", jsonData.email);"],"type":"text/javascript"}}],"id":"99fd2a79-f790-41d2-a731-1d446db65cce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientReferenceId\": \"adde719f-9b60-47a4-a397-5161f912f2a2\",\n \"givenName\": \"John\",\n \"familyName\": \"Smith\",\n \"email\": \"296a198e-d6a0-445f-a55e-ec5f9e804fd0@dispostable.com\",\n \"ssn\": \"123456789\",\n \"dob\": \"1990-01-01\",\n \"address\": {\n \"addressLine\": \"123 Sterling St.\",\n \"municipality\": \"Bothell\",\n \"regionCode\": \"US-WA\",\n \"postalCode\": \"98011\",\n \"countryCode\": \"US\"\n }\n}"},"url":"{{host}}/v1/candidates/{{candidate_id}}","description":"Update an existing candidate's information.
\nnull value in your request will delete that data from the candidate as long as it is not required.clientReferenceId cannot be updated.Candidates with Existing Screenings
\n\n\n","urlObject":{"path":["v1","candidates","{{candidate_id}}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"3c02be67-84f3-496e-813f-d873e80c4945","name":"Missing Required Field","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"body":{"mode":"raw","raw":"{\n \"clientReferenceId\": \"e4e1ffda-caa3-ea6d-c095-be8429b31154\",\n \"givenName\": \"Johnny\",\n \"familyName\": \"Smith\"\n}"},"url":"{{host}}/v1/candidates/988293912"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"63"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 May 2019 18:07:01 GMT"},{"key":"x-amzn-RequestId","value":"0f7f5d82-6d05-11e9-a3e8-47371c18feed"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZES1RFeMIAMFWtw="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccb31bb-b973d7ca84c27c94cafcc3ac"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 7b01019810c971756b017bcc76055c79.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"g5jl1llLnPC01HlyBkmmc1F9P3zzptF_p5NweAD4MQ4xX9doXOX4rw=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400#email\",\n \"message\": \"email is required\"\n }\n ]\n}"},{"id":"9d9f4734-8f4a-48ce-b8c1-68c258a272a3","name":"Update Candidate","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"body":{"mode":"raw","raw":"{\r\n \"clientReferenceId\": \"e4e1ffda-caa3-ea6d-c095-be8429b31154\",\r\n \"email\": \"new-john-email@example.com\",\r\n \"givenName\": \"Johnny\",\r\n \"familyName\": \"Smith\",\r\n \"dob\": \"1975-02-28\",\r\n \"ssn\": \"555555555\",\r\n \"phone\": \"+12121231234\",\r\n \"address\": {\r\n \"addressLine\": \"222333 PEACHTREE PLACE\",\r\n \"municipality\": \"ATLANTA\",\r\n \"regionCode\": \"US-GA\",\r\n \"postalCode\": \"30318\",\r\n \"countryCode\": \"US\"\r\n },\r\n \"driversLicense\": {\r\n \"type\": \"personal\",\r\n \"licenseNumber\": \"S1234567\",\r\n \"issuingAgency\": \"CA\"\r\n }\r\n}"},"url":"{{host}}/v1/candidates/988293912"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"484"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 May 2019 18:05:33 GMT"},{"key":"x-amzn-RequestId","value":"de325d2b-6d04-11e9-b7fa-79f69c8aabb5"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZESoWEK4IAMFSbQ="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccb3168-f30d50685c1fb489c26e805c;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7b01019810c971756b017bcc76055c79.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"nXg8wpNHIWGu10GbahFQ4b1F76f6Lob-IdfJhTVabGrh6aLM4O1imw=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"988293912\",\n \"clientReferenceId\": \"e4e1ffda-caa3-ea6d-c095-be8429b31154\",\n \"email\": \"new-john-email@example.com\",\n \"givenName\": \"Johnny\",\n \"familyName\": \"Smith\",\n \"confirmedNoMiddleName\": true,\n \"dob\": \"1975-02-28\",\n \"ssn\": \"555555555\",\n \"phone\": \"+12121231234\",\n \"address\": {\n \"addressLine\": \"222333 PEACHTREE PLACE\",\n \"municipality\": \"ATLANTA\",\n \"regionCode\": \"US-GA\",\n \"postalCode\": \"30318\",\n \"countryCode\": \"US\"\n },\n \"screeningIds\": [],\n \"driversLicense\": {\n \"type\": \"personal\",\n \"licenseNumber\": \"S1234567\",\n \"issuingAgency\": \"CA\"\n }\n}"}],"_postman_id":"99fd2a79-f790-41d2-a731-1d446db65cce"},{"name":"Get Candidate","event":[{"listen":"test","script":{"id":"53536aed-c397-4ea9-b08f-f68539ea2a5d","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"78006820-1cf5-4ff2-9a11-6a68d8c90249","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}","type":"text"}],"url":"{{host}}/v1/candidates/{{candidate_id}}","description":"When you create a new screening, the data that is collected will be what was currently set on the candidate at that time. Updating the candidate afterwards will not impact their existing screenings.
\n
Retrieve a candidate by their unique candidate_id. This will return all the most recent information on the candidate.
Return a list of all available candidates. You may filter these results using the provided query params below.
\n","urlObject":{"path":["v1","candidates"],"host":["{{host}}"],"query":[{"disabled":true,"description":{"content":"Filter by the provided clientReferenceId value.
\n","type":"text/plain"},"key":"clientReferenceId","value":"clientReferenceId"},{"disabled":true,"description":{"content":"Filter by the provided email value.
\n","type":"text/plain"},"key":"email","value":"email"},{"disabled":true,"description":{"content":"Filter by the provided given name.
\n","type":"text/plain"},"key":"givenName","value":"givenName"},{"disabled":true,"description":{"content":"Filter by the provided family name.
\n","type":"text/plain"},"key":"familyName","value":"test"},{"disabled":true,"description":{"content":"Limit results to the specified number.
\n","type":"text/plain"},"key":"limit","value":"limit"},{"disabled":true,"description":{"content":"Offset the results by the specified number.
\n","type":"text/plain"},"key":"offset","value":"offset"}],"variable":[]}},"response":[{"id":"d619867d-efbe-48fe-a4a4-b4c9032b8275","name":"Get All Candidates","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"url":"{{host}}/v1/candidates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"4414"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 May 2019 19:26:46 GMT"},{"key":"x-amzn-RequestId","value":"33bc6634-6d10-11e9-8101-bd139a33d445"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZEeg-GILIAMFphQ="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccb446c-a76822c82dfce71a1867fe09;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 097fbf718c1b805deaed8941b59761cc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"AZVGaImbdklYULTB0rcNvGI7ELcXgrJCjjFEhHvQhFr1rZAuvaJWpg=="}],"cookie":[],"responseTime":null,"body":"[\n\t{\n\t \"id\": \"988293912\",\n\t \"clientReferenceId\": \"e4e1ffda-caa3-ea6d-c095-be8429b31154\",\n\t \"email\": \"john-test@example.com\",\n\t \"givenName\": \"John\",\n\t \"familyName\": \"Doe\",\n\t \"confirmedNoMiddleName\": true,\n\t \"dob\": \"1998-07-18\",\n\t \"ssn\": \"123456789\",\n\t \"phone\": \"+14041231234\",\n\t \"address\": {\n\t \"addressLine\": \"123 Sterling Street\",\n\t \"municipality\": \"Bellevue\",\n\t \"regionCode\": \"US-WA\",\n\t \"postalCode\": \"98011\",\n\t \"countryCode\": \"US\"\n\t },\n\t \"aliases\": [\n\t {\n\t \"givenName\": \"Robert\",\n\t \"familyName\": \"Saur\",\n\t \"middleName\": \"William\",\n\t \"confirmedNoMiddleName\": false\n\t },\n\t {\n\t \"givenName\": \"Simon\",\n\t \"familyName\": \"Duck\",\n\t \"confirmedNoMiddleName\": true\n\t }\n\t ],\n\t \"screeningIds\": [],\n\t \"driversLicense\": {\n\t \"type\": \"personal\",\n\t \"licenseNumber\": \"S1234567\",\n\t \"issuingAgency\": \"CA\"\n\t }\n\t},...\n]"}],"_postman_id":"a54ee13e-f064-40e3-bb34-0fc15943a1ed"},{"name":"Generate Candidate Portal Link","id":"687d0a75-c51e-4b69-865f-2e96fd4ad23b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"url":"{{host}}/v1/candidates/{{candidate_id}}/links","description":"Generate a new one-time use link to the Candidate portal will expire without use after 10 minutes. This link allows the candidate to view and complete their existing screenings.
\n","urlObject":{"path":["v1","candidates","{{candidate_id}}","links"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"74cde3b5-dd4c-41ee-8b3a-a5cbe722d120","name":"Candidate Not Found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{host}}/v1/candidates/54321/links"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"143"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 May 2019 19:42:43 GMT"},{"key":"x-amzn-RequestId","value":"712994ac-6d12-11e9-bfc1-6529803fbc2d"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZEg3SGrKoAMF3Rw="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccb482e-555131fec11664c69ca7662e"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 b005949014b117aed39cd14f2e31cfb9.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"16kZDr-URo458irKT2wICxMbJz1nFLgSEgshlMZ2CIY8XRmlmAKa8Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400#candidateId?not-found\",\n \"message\": \"candidateId must be a valid candidateId associated with the authenticated account\"\n }\n ]\n}"},{"id":"96a8019c-07c6-4009-a367-0e82f01eee23","name":"Generate Candidate Link","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{host}}/v1/candidates/988546883/links"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"527"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 May 2019 19:40:52 GMT"},{"key":"x-amzn-RequestId","value":"2e08fb3a-6d12-11e9-a89a-81a491d566d2"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZEglsFxaIAMFy_g="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccb47be-f1ee949400f06442fe0b5946;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b005949014b117aed39cd14f2e31cfb9.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"jvbWkhNJgvYvY5uunp6sSK0ODfUf3PCHV2GwFgXdg7lfW6rs3H-EAQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"candidatePortal\": \"https://portal.int.talentwise.com/438a7d2ee6/ptl/dashboard.php?Sender=16902380&Email=8b768f57-7f86-4b8c-b4de-b99f2f0ae49a%40example.com&OverrideCandidateID=988294095&KennectApiToken=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOnsiY2FuZGlkYXRlX2lkIjo5ODgyOTQwOTUsInNlbmRlciI6MTY5MDIzODAsImVtYWlsIjoiOGI3NjhmNTctN2Y4Ni00YjhjLWI0ZGUtYjk5ZjJmMGFlNDlhJTQwZXhhbXBsZS5jb20ifSwiZXhwIjoxNTU2ODI2NjUyLCJqdGkiOiI5ODgyOTQwOTVfZXhHV3ZvNElhSTUwR2xKYmk2cXp6RGlJeTl0S1dhMmEifQ.b6zhmzVdvRbXh48YVE7tyHj2bVCXEfcth6kdRWcvAYg\"\n}"}],"_postman_id":"687d0a75-c51e-4b69-865f-2e96fd4ad23b"}],"id":"89600b46-5f7e-4232-aab0-6d70154e254b","description":"A candidate is a person who will be the subject of a future screening. In many cases, a candidate will be created and screened immediately in a single session. Alternatively, a candidate can be created in advance for future screenings, screened with different packages over time as part of a role change, or may be screened every few months as part of an existing role.
\nBy design, candidate records can be created with only a handful of required fields, to allow for use cases like step-by-step data collection across multiple user interactions. Because different kinds of screenings need different information about the candidate in order to effectively search for their background data, there is no single set of universally required fields for all screening types.
\nWhen building code to collect data from candidates within your own application, the best user experience in most cases is to collect all the data you will need in a single form. Because application developers typically know in advance what packages they will use to screen candidates, the best way to ensure that you are collecting all the data you need from your candidates is to look up the list of requiredFields using the Packages resource.
The candidate's email and clientReferenceId must be unique. When updating a candidate all previously provided fields should be included in the request body with their desired values, not only those fields with intended changes.
Request an SSN trace and receive the result immediately within the API response.
\nTrace Results
\nA trace's result property provides a better depiction of how the report went down.
The /traces endpoint will create an SSN Trace on a candidate
\nBy sending a POST request to /traces, you can receive results for the trace immediately within the API response to your request. The response should give a quick glimpse into whether your candidate's name and SSN information match and a list of addresses associated with them.
Create a new screening for a candidate using a Client-side data collection flow.
\nThe status and result of a screening response depends on the data submitted to the screening.\nSome of the attribute values:
Request Body Fields
\n","urlObject":{"path":["v1","screenings"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"4bf696ee-b290-4f72-b033-11d131a92265","name":"Create Screening","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"idempotency-key","value":"","description":"The API supports idempotency for safely retrying screening requests without accidentally performing the same operation twice.","disabled":true}],"body":{"mode":"raw","raw":"{\n \"packageId\": \"64731\",\n \"candidateId\": \"864109\",\n \"endUserCertificate\": \"true\",\n \"callback\": {\n \"uri\": \"https://my-company.com/screenings-callback\",\n \"credentials\": {\n \"basic-auth\": \"narf:zort!\"\n }\n },\n \"referenceCodes\": [\n \"US\",\n \"WA\",\n \"Seattle\"\n ],\n \"billingCode\": \"Northwest\"\n}"},"url":"{{host}}/v1/screenings"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2120"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 May 2019 21:04:18 GMT"},{"key":"x-amzn-RequestId","value":"d5d2c591-6d1d-11e9-84d0-a3938cfe6e90"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZEsz4FWCoAMFQig="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccb5b4c-d24de343671607e649a305e2"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 91ed69d49df50f5558b0d5ebe4b3af7a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"L12nx8v2Txi36QPdtweOOxROfZ0GtenNFt6dxDn4T50vBNp34ruVyw=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"001000063225945\",\n \"packageId\": \"64731\",\n \"candidateId\": \"864109\",\n \"status\": \"pending\",\n \"result\": \"n/a\",\n \"reportItems\": [\n {\n \"id\": \"63225946\",\n \"type\": \"Criminal Check by Jurisdiction\",\n \"status\": \"pending\",\n \"result\": \"n/a\",\n \"updatedAt\": \"2017-05-04T20:36:33Z\"\n },\n {\n \"id\": \"63225947\",\n \"type\": \"Federal Criminal Check\",\n \"status\": \"pending\",\n \"result\": \"n/a\",\n \"updatedAt\": \"2017-05-04T20:36:33Z\"\n },\n {\n \"id\": \"63225948\",\n \"type\": \"Multi-State Instant Criminal Check\",\n \"status\": \"pending\",\n \"result\": \"n/a\",\n \"updatedAt\": \"2017-05-04T20:36:33Z\"\n },\n {\n \"id\": \"63225949\",\n \"type\": \"Nationwide Sex Offender Registry Check\",\n \"status\": \"pending\",\n \"result\": \"n/a\",\n \"updatedAt\": \"2017-05-04T20:36:33Z\"\n }\n ],\n \"submittedAt\": \"2017-05-04T20:36:33Z\",\n \"updatedAt\": \"2017-05-04T20:36:33Z\",\n \"links\": {\n \"admin\": {\n \"web\": \"https://integration.talentwise.com/screening/report.php?ApplicantID=63225945\",\n \"pdf\": \"https://integration.talentwise.com/screening/pdf-report.php?ApplicantID=63225945\"\n }\n },\n \"callback\": {\n \"uri\": \"https://my-company.com/screenings-callback\"\n },\n \"adverseActions\": []\n}"},{"id":"f7de5cfd-06b6-4c3f-b315-d801c2e85abd","name":"Bad Billing Code","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"idempotency-key","value":"","description":"The API supports idempotency for safely retrying screening requests without accidentally performing the same operation twice.","disabled":true}],"body":{"mode":"raw","raw":"{\n \"candidateId\": \"988294023\",\n \"packageId\": \"164741\",\n \"callback\": {\n \"uri\": \"https://my-company.com/screenings-callback\",\n \"credentials\": {\n \"basic-auth\": \"narf:zort!\"\n }\n },\n \"billingCode\": \"fakeCode\"\n}"},"url":"{{host}}/v1/screenings"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"80"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 May 2019 21:32:44 GMT"},{"key":"x-amzn-RequestId","value":"ce418726-6d21-11e9-9877-15394a3f2500"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZEw-VFZQoAMFzoA="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccb61f5-54afd9698dbd6b41ef34ef76;Sampled=0"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 097fbf718c1b805deaed8941b59761cc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"jQR2KalYR9KISppSLs5_s7K2HKBYj6UaaIcqk-LmnrWQfiN9Zw9kQQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400#billingCode?invalid\",\n \"message\": \"Invalid Billing Code\"\n }\n ]\n}"},{"id":"cc61bb03-5d3e-46a4-ad91-7d78b654ed1f","name":"Bad Callback URI","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"idempotency-key","value":"","description":"The API supports idempotency for safely retrying screening requests without accidentally performing the same operation twice.","disabled":true}],"body":{"mode":"raw","raw":"{\n \"candidateId\": \"988294023\",\n \"packageId\": \"164741\",\n \"callback\": {\n \"uri\": \"http://my-company.com/screenings-callback\",\n \"credentials\": {\n \"basic-auth\": \"narf:zort!\"\n }\n }\n}"},"url":"{{host}}/v1/screenings"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"98"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 May 2019 21:33:57 GMT"},{"key":"x-amzn-RequestId","value":"fe02423e-6d21-11e9-a625-13627a9473e5"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZExK2HICoAMF_Pw="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccb6245-1a4a4bec52270f00c2af2e5c"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 097fbf718c1b805deaed8941b59761cc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"O9kIZRG377wjGKPWJ25C7bGH8D7Bibk87T_EgGRtaTutlkPd1atY6w=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400#callback.uri?format\",\n \"message\": \"callback.uri must be a valid https url\"\n }\n ]\n}"}],"_postman_id":"9f0d3200-3091-4fd4-9487-80aad5028e20"},{"name":"Create Screening (Sterling Data Collection)","event":[{"listen":"test","script":{"id":"1402668f-415a-4710-8d25-76bf2435ee10","exec":["var jsonData = JSON.parse(responseBody);","tests[\"Status code is 201\"] = responseCode.code === 201;","postman.setGlobalVariable(\"screening_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"ce472be4-1196-4d7d-b8db-6945478801b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"body":{"mode":"raw","raw":"{\n \"packageId\": \"8398190\",\n \"candidateId\": \"{{candidate_id}}\"\n}"},"url":"{{host}}/v1/screenings","description":"Create a new screening for a candidate using a Sterling data collection flow. Adding an additional invite field will allow Sterling to guide your candidate through our Candidate workflow to collect their information before running the background check.
The status and result of a screening response depends on the data submitted to the screening.\nSome of the attribute values:
Request Body Fields
\n","urlObject":{"path":["v1","screenings"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"0940f7e1-05a4-42ef-9a23-d6ceb03354cc","name":"Create Screening Via Email Method","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"idempotency-key","value":"","description":"The API supports idempotency for safely retrying screening requests without accidentally performing the same operation twice.","disabled":true}],"body":{"mode":"raw","raw":"{\n \"candidateId\": \"988294023\",\n \"packageId\": \"164741\",\n \"callback\": {\n \"uri\": \"https://my-company.com/screenings-callback\",\n \"credentials\": {\n \"basic-auth\": \"narf:zort!\"\n }\n },\n \"invite\": {\n \t\"method\": \"email\"\n }\n}"},"url":"{{host}}/v1/screenings"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"285"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 May 2019 21:30:21 GMT"},{"key":"x-amzn-RequestId","value":"7b1c9609-6d21-11e9-a3cf-f90004a878c7"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZEwoiHKrIAMF8gg="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccb6169-f81e373a318d059a9a362270"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 097fbf718c1b805deaed8941b59761cc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"w5r4nxXF1E1FXMsortsCXSib0KuWBBdyGqOeciz8tSRQnWKEllY7sw=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"002000001239706\",\n \"packageId\": \"164741\",\n \"candidateId\": \"988294023\",\n \"status\": \"new\",\n \"result\": \"n/a\",\n \"submittedAt\": \"2019-05-02T21:30:19Z\",\n \"updatedAt\": \"2019-05-02T21:30:19Z\",\n \"invite\": {\n \"method\": \"email\"\n },\n \"callback\": {\n \"uri\": \"https://my-company.com/screenings-callback\"\n },\n \"adverseActions\": []\n}"},{"id":"983d432a-9876-4aa3-aa23-19d3f581993d","name":"Create Screening via Link Method","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"idempotency-key","value":"","description":"The API supports idempotency for safely retrying screening requests without accidentally performing the same operation twice.","disabled":true}],"body":{"mode":"raw","raw":"{\n \"candidateId\": \"988294023\",\n \"packageId\": \"164741\",\n \"callback\": {\n \"uri\": \"https://my-company.com/screenings-callback\",\n \"credentials\": {\n \"basic-auth\": \"narf:zort!\"\n }\n },\n \"invite\": {\n \t\"method\": \"link\"\n }\n}"},"url":"{{host}}/v1/screenings"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"805"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 May 2019 21:31:10 GMT"},{"key":"x-amzn-RequestId","value":"94dd7352-6d21-11e9-8c57-43f9a85e406c"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZEwvSHXZIAMFxwg="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccb6195-adf421ef26e9687b60d6193a"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 097fbf718c1b805deaed8941b59761cc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"qMaIPt6BBt4fgf3f0tlV0tb1SEQAD5UGbfdA_vhjf6LbRPzepY5P4g=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"002000001239708\",\n \"packageId\": \"164741\",\n \"candidateId\": \"988294023\",\n \"status\": \"new\",\n \"result\": \"n/a\",\n \"submittedAt\": \"2019-05-02T21:31:07Z\",\n \"updatedAt\": \"2019-05-02T21:31:07Z\",\n \"invite\": {\n \"method\": \"link\",\n \"link\": \"https://portal.int.talentwise.com/438a7d2ee6/ptl/ticketeda.php?ID=MTY5MDIzODA&confirmationCode=GNanZSU93mb2Ucbj&ticket=1239708&Sender=16902380&Email=john-test3%40example.com&OverrideCandidateID=988294023&KennectApiToken=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOnsiY2FuZGlkYXRlX2lkIjo5ODgyOTQwMjMsInNlbmRlciI6IjE2OTAyMzgwIiwiZW1haWwiOiJqb2huLXRlc3QzJTQwZXhhbXBsZS5jb20ifSwiZXhwIjoxNTU2ODMzMjcwLCJqdGkiOiI5ODgyOTQwMjNfMnljbUxKcllMSU5CTzk2cmRJMHdySVVvOURLbkxxdlYifQ.aYP5OoZ0m-cEvP9FLR4o1qoND3l8mmkvGBsExwrXYcs\"\n },\n \"callback\": {\n \"uri\": \"https://my-company.com/screenings-callback\"\n },\n \"adverseActions\": []\n}"}],"_postman_id":"ce472be4-1196-4d7d-b8db-6945478801b7"},{"name":"Retrieve Screening","event":[{"listen":"test","script":{"id":"d9e23e73-6f4f-4e57-b7e5-b5a90701e7d8","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"582738ed-c2d2-48b4-9ced-94faf8c7af5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"url":"{{host}}/v1/screenings/{{screening_id}}","description":"Retrieve a screening using a provided screening id.
Retrieve the screening report item details using a provided screening id. This will also capture and display any additional details on the packages if they exist that a normal GET call on a screening would not.
This request provides an option to view the Screening report and it is a one-time link.
\n\n\n","urlObject":{"path":["v1","screenings","{{screening_id}}","report-links"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"1b90f374-3572-4e3f-81d6-8a9c00442750","name":"Screening Not Complete","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{host}}/v1/screenings/001000991383470/report-links"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"123"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 22 May 2020 21:37:22 GMT"},{"key":"x-amzn-RequestId","value":"d59232fd-5d6a-49f7-aa82-7f4ec97e82e6"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"M8_iuHkSoAMFUOQ="},{"key":"Request-Id","value":"7000353b-3a9a-48a8-a0e3-a9092afeb6ae"},{"key":"x-amzn-Remapped-Date","value":"Fri, 22 May 2020 21:37:22 GMT"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 0570243541aa4edb51d3f1e60aee5a33.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD79-C2"},{"key":"X-Amz-Cf-Id","value":"YpLkVb92WVBMTV7SViMIOnOVM24fw_GaMT7YV9YiDNnWQjgIPDDZew=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"422#not-yet-complete\",\n \"message\": \"The screening report cannot be shared until the report is complete\"\n }\n ]\n}"},{"id":"3c410c20-9c65-4fd3-bb5f-0cfece15d3e3","name":"Create Screening Report Link","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"url":"{{host}}/v1/screenings/001000988812965/report-links"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"656"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 02 May 2019 22:18:17 GMT"},{"key":"x-amzn-RequestId","value":"2c1a2158-6d28-11e9-be34-1fade262c547"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZE3plGmNoAMFTnw="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccb6ca3-d5ff83604d008fe08a1f0870"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7fec31050f9483acb01255d9c8868bfa.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"EQZ2q50UUuHlpyMXtzTTPdPSwRn05un9L4ehyBMf1TT3mAKwULBdVw=="}],"cookie":[],"responseTime":null,"body":"{\n \"html\": \"https://portal.int.talentwise.com/438a7d2ee6/ptl/myreport.php?Sender=16902380&Email=2dcd3399-e690-4d8a-adf1-9856fad61fba%40example.com&ReportId=988812965&OverrideCandidateID=987897227&KennectApiToken=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOnsiY2FuZGlkYXRlX2lkIjo5ODc4OTcyMjcsInNlbmRlciI6IjE2OTAyMzgwIiwiZW1haWwiOiIyZGNkMzM5OS1lNjkwLTRkOGEtYWRmMS05ODU2ZmFkNjFmYmElNDBleGFtcGxlLmNvbSJ9LCJleHAiOjE1NTY4MzYwOTcsImp0aSI6Ijk4Nzg5NzIyN19yR3dYcGtzWFFxUVZOYnl3QmR1bVA2UVkzZTNXU29MSSJ9.iRCXX0Mvtceqa7XOxf4LxiLeddG5wisLdV1DMEYlFc8\",\n \"pdf\": \"https://api-int.kennect.com/v1/screenings/001000988812965/report.pdf?token=75fd804e-24a1-4283-9b5e-e07fb56ecc83\"\n}"}],"_postman_id":"053178c0-e45b-4e27-afcd-2de5b8037038"},{"name":"Generate Screening Report","id":"a74e2dc0-3aab-4793-9f4b-a9f9447f5251","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"url":"{{host}}/v1/screenings/{{screening_id}}/report","description":"This request will generate a tokenized, one-time use link that will expire without use after 10 minutes.
\n
GET request that generates and allows the retrieval of a screening report (screening_id required) with no restrictions on time or use.
A screening is a background check on a candidate with a specific package.
\nOnce a candidate is created and a package has been selected, the screening can be initiated on that candidate by calling the POST /v1/screenings endpoint. The turnaround time for completion of a screening is variable. Most screening reports are returned within 24-72 hours, and the results can be found by calling GET /v1/screenings/{id}, where {id} is the identifier for the screening.
An application can subscribe to updates on the fulfillment of a screening using the callback field. Callbacks will be POSTed to the provided URL for any changes screening status, including adverse actions and disputes as well as changes to the report items. (See Callbacks)
The Sterling API supports two different data collection flows. We first have a Client-side Data Collection flow, where you collect your candidates' information on your end. The other option is the Sterling Data Collection flow where Sterling takes the responsibility of collecting your candidates' data.
\nIf you prefer to have your entire background check process to remain within your company's domain, a client-side flow may work for you. This allows you to customize your candidate experience from start to finish. It also may be a quicker solution as the candidate is not required to check their email account to follow-up.
\nPOST /screenings
\n{\n \"packageId\": \"64731\",\n \"candidateId\": \"864109\"\n}\nThe Sterling Data Collection flow is an option that Sterling provides to bridge the API to the underlying platforms. It allows you to specify a method that a candidate can take to finish the screening process. Sterling's platforms will manage the candidate experience once the invite is accepted. This includes the collection of consent and disclosure electronically, as well as the collection of any extra necessary information that is pertinent to the screening.
\nThe two supported options for method are link and email.
\n\nThe
\nlinkoption will generate a tokenized, one-time use link that will expire without use after 10 minutes. This gives you the option to customize how the candidate receives this link (i.e. buttons, custom emails, etc).The
\n
POST /screenings
\n{\n \"packageId\": \"64731\",\n \"candidateId\": \"864109\",\n \"invite\": {\n \"method\": \"link\" | \"email\"\n }\n}\nRetrying Screening Requests
\n\n\n","event":[{"listen":"prerequest","script":{"id":"db0c1673-08a7-49c9-ad4f-8b903bda7f3a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"16fdce12-f5ec-41a9-ae59-76fe5d448c55","type":"text/javascript","exec":[""]}}],"_postman_id":"7c44b320-fa1e-4da8-b37a-2cdaab8bf10a"},{"name":"Invite","item":[{"name":"Create Screening Invite","id":"79fa72d3-296e-4ed5-afee-8b2e62a77c1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"invite\": {\n \"method\": \"link\"\n }\n}"},"url":"{{host}}/v1/screenings/{{screening_id}}/invite","description":"The API also supports Idempotency for safely retrying screening requests without accidentally performing the same operation twice and creating duplicate screenings.
\n
Create a new link invite for an existing screening.
\n","urlObject":{"path":["v1","screenings","{{screening_id}}","invite"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"1e1ac7a1-2fcc-4ce0-977f-f35e3a080b24","name":"Create Screening Invite","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"invite\": {\n \"method\": \"link\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/screenings/002000001317269/invite"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"151"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 22 May 2020 21:50:22 GMT"},{"key":"x-amzn-RequestId","value":"657b6c4e-b1b3-47f4-bab3-628c11f952bf"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"M9BcoGq8oAMFW1Q="},{"key":"Request-Id","value":"a8ab635c-d828-4032-a6f8-cbf84521012b"},{"key":"x-amzn-Remapped-Date","value":"Fri, 22 May 2020 21:50:22 GMT"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 685083d3a5f8eecb6c517728d821ec87.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD79-C1"},{"key":"X-Amz-Cf-Id","value":"Jc6yg4Fe2h8PjIXWuxbvX7Y2Ce7j8tnXpyxKYTUkYrKc7VAIPT-R9A=="}],"cookie":[],"responseTime":null,"body":"{\n \"invite\": {\n \"method\": \"link\",\n \"link\": \"https://portal.integration.talentwise.com/438a7d2ee6/ptl/ticketeda.php?ID=MTY5MDIzODA&code=FwLsDCxhI804fEiZ&ticket=472316&&Sender=18902380&Email=515d9b1e-f197-464f-9bdc-2258520d7fac%40example.com&OverrideCandidateID=3317606&KennectApiToken=hash-token\"\n }\n}"},{"id":"47118395-d9dd-4601-b0d1-6478b177ebcf","name":"Invalid Method","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"invite\": {\n \"method\": \"email\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/screenings/001000991383470/invite"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"129"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 22 May 2020 21:52:54 GMT"},{"key":"x-amzn-RequestId","value":"876a0eaa-7781-4eef-8712-de1c5cb05866"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"M9B0fGJmIAMFvIQ="},{"key":"Request-Id","value":"fa487fdd-eabd-4726-be7f-a49269a693a9"},{"key":"x-amzn-Remapped-Date","value":"Fri, 22 May 2020 21:52:54 GMT"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 685083d3a5f8eecb6c517728d821ec87.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD79-C1"},{"key":"X-Amz-Cf-Id","value":"xyo9cM_C8XLyjkzojEnXX0Hbrh8m4KLMcJUsh_kfpPaudaIR_Zpl3w=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400#method?invalid\",\n \"message\": \"Invalid method. Resending invite is only supported to invite through links\"\n }\n ]\n}"},{"id":"8f2810d4-2753-46ec-9dc8-8537ed45150d","name":"Invalid Screening Type","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"invite\": {\n \"method\": \"link\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/screenings/002000001317271/invite"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"151"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 22 May 2020 21:51:15 GMT"},{"key":"x-amzn-RequestId","value":"2ff0cadb-d8c8-46c5-bbdf-12229516b4b8"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"M9Bk5GVsoAMF7vA="},{"key":"Request-Id","value":"e3a24244-fbb3-4749-ae7d-364db1ec5f2c"},{"key":"x-amzn-Remapped-Date","value":"Fri, 22 May 2020 21:51:15 GMT"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 685083d3a5f8eecb6c517728d821ec87.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD79-C1"},{"key":"X-Amz-Cf-Id","value":"y_f8fPOEUQN8xCjlLy3cMQfhdyaZ3EXMDp9CE_qdBw1GyhMobOnaHA=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400#isNotLinkInvite\",\n \"message\": \"The screening was not created using an invite through link. Please provide a valid screening ID\"\n }\n ]\n}"},{"id":"cb127e2f-bdee-4977-8e49-ffd7c5754069","name":"No Invite Method Provided","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{host}}/v1/screenings/001000991383470/invite"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"54"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 22 May 2020 21:52:11 GMT"},{"key":"x-amzn-RequestId","value":"170b62d8-b3a1-4414-8c81-0098168cace8"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"M9Bt0GwEoAMFZPw="},{"key":"Request-Id","value":"473d0dba-08db-4b9c-b211-038a5bbc875b"},{"key":"x-amzn-Remapped-Date","value":"Fri, 22 May 2020 21:52:11 GMT"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 685083d3a5f8eecb6c517728d821ec87.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD79-C1"},{"key":"X-Amz-Cf-Id","value":"sTV4iOlFUBLfG9S3M1czmknB7c5qTI6g7rlgNtV7FZeN5JVr0AoDeA=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400\",\n \"message\": \"Malformed JSON\"\n }\n ]\n}"}],"_postman_id":"79fa72d3-296e-4ed5-afee-8b2e62a77c1d"}],"id":"e0473828-7fa7-477c-856a-523e7bed3fe1","description":"Invite for screening. Please refer to the Screening section for more details.
\nJSON Examples
\n\"invite\": {\n \"method\": \"link\",\n \"link\": \"https://portal.integration.talentwise.com/438a7d2ee6/ptl/ticketeda.php?ID=MTY5MDIzODA&code=7C3bGnsqq1Zw8jUQ&ticket=423829&&Sender=16902380&Email=deckarda7b83455-07e6-818f-d474-293605e7d663%40example.com&OverrideCandidateID=864109&KennectApiToken=token-hash\"\n }\n\"invite\": {\n \"method\": \"email\"\n}\nCreate an adverse action report using a screening_id to create an adverse report. A successful call will return a 201 with no response body to show.
Request Body Fields
\n","urlObject":{"path":["v1","screenings","{{screening_id}}","adverse-actions"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"c57acf62-fae6-4d40-b763-586b0314af9a","name":"Adverse Action Already Initiated","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reportItems\": [\n \"991383481\"\n ],\n \"comments\": \"Candidate put in wrong SSN value; Will need to re-input.\"\n}"},"url":"{{host}}/v1/screenings/001000991383480/adverse-actions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"137"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 22 May 2020 22:11:38 GMT"},{"key":"x-amzn-RequestId","value":"5efe3203-c520-41fd-8b57-dcb4b1246455"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"M9Ej7GQvoAMFUZQ="},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Request-Id","value":"49779002-1d08-4651-b970-910715f1b58e"},{"key":"x-amzn-Remapped-Date","value":"Fri, 22 May 2020 22:11:38 GMT"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 7d5b81244bd8116fcbcfa4c6fef02f93.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD79-C2"},{"key":"X-Amz-Cf-Id","value":"4ZoYBcpsr2SWwpqf2Wv6w8rbJEaxsh6Sd_qzR9KhPCBKi354SOr5MQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400#adverse-action-already-in-process\",\n \"message\": \"An adverse action has already been initiated for this screening\"\n }\n ]\n}"}],"_postman_id":"2bb89ce8-8457-44b4-aeda-97cf33a0b767"}],"id":"c8fdf768-002c-4bad-ab5c-dc0e96b4dce7","description":"Under the Fair Credit Reporting Act, candidates are entitled to receive notice when there is a chance that they could be denied an opportunity based in whole or in part on the contents of a background report. This process is called “Adverse Action”, and includes an initial “pre-adverse” notice to the candidate with an opportunity to dispute the contents of the report. A successful dispute can overturn the adverse action, but a failed dispute or an undisputed adverse action will lead to a final notice of adverse action.
\nThe applicant is given a chance to review their background report, and dispute the findings if it is incomplete or inaccurate before a final decision is made. In order to start an adverse action, phone number is required on the candidate.
\n","_postman_id":"c8fdf768-002c-4bad-ab5c-dc0e96b4dce7"},{"name":"Documents","item":[{"name":"Attach Screening Document","id":"7f619ced-36a8-4ca6-8455-e63d749e7ba5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}","type":"text"},{"key":"Content-Type","value":"application/octet-stream","type":"text"}],"body":{"mode":"file","file":{}},"url":"{{host}}/v1/screenings/{{screening_id}}/documents","description":"Attach documents to an existing screening id. If successful, a 201 Created response will be returned, but with no visible JSON output. You can confirm the addition by calling one of the GET endpoints in this section.
Possible values: candidate , trusted-user
Possible values: disclosure-and-authorization, end-user-agreement.
List all the documents of a screening.
\n","urlObject":{"path":["v1","screenings","{{screening_id}}","documents"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"f10fe2c7-9613-41d8-ab5d-fd991fe12215","name":"List All Screening Documents","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"url":"{{host}}/v1/screenings/001000063225945/documents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"445"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 03 May 2019 17:52:17 GMT"},{"key":"x-amzn-RequestId","value":"306d0db6-6dcc-11e9-928e-b7a48cf3f604"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZHjokE3IoAMF0pg="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccc7fd0-78cf8cfc6b1de02424b18dc2"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 ed7bccbdf1dd6cc7ca3376d49c334132.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"tUxXjnqx_FfMwKaNsijTA7TiW_ml79wRxaga655C0jaKL2W6EdKUPw=="}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"2341245\",\n \"candidateId\": \"927084\",\n \"fileName\": \"disclosure-and-authorization_candidate_2942bfab-b3d0-3332-b66e-b128e0842cff.pdf\",\n \"fileType\": \"Attachment\",\n \"createdAt\": \"2019-05-03T17:51:54Z\",\n \"updatedAt\": \"2019-05-03T17:51:54Z\"\n },\n {\n \"id\": \"2341244\",\n \"candidateId\": \"927084\",\n \"fileName\": \"end-user-agreement_candidate_2942bfab-b3d0-3332-b66e-b128e0842cff.pdf\",\n \"fileType\": \"Attachment\",\n \"createdAt\": \"2019-05-03T17:13:27Z\",\n \"updatedAt\": \"2019-05-03T17:13:27Z\"\n }\n]"}],"_postman_id":"6e18b0f4-2adb-417f-8156-f4295d1e47ba"},{"name":"Retrieve Screening Document","event":[{"listen":"test","script":{"id":"946e4f8d-e69e-414f-a650-e2c6211e9c31","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"6e9de92e-9b9b-4271-b87e-887d5857bd8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"url":"{{host}}/v1/screenings/{{screening_id}}/documents/{attachment_id}","description":"GET request to fetch a single document associated with a screening.
Request Body Fields
\n","urlObject":{"path":["v1","screenings","{{screening_id}}","documents","{attachment_id}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e9de92e-9b9b-4271-b87e-887d5857bd8a"}],"id":"834e3ea7-02a5-43dc-bfc8-415ca25da46f","description":"In some cases, supporting documents must be provided for a candidate or a screening to be completed and made available to requesters. The payload of the POST request should be the binary file contents, represented as a stream or array of bytes. Avoid encoding the payload as text, as this will result in blank, unreadable PDF files.
Care should be taken with binary file contents, as some languages may change encoding internally. Check your library's documentation for handling binary data.
\n\n\n","event":[{"listen":"prerequest","script":{"id":"1375d0cf-8582-46e4-b2d3-52d426db5489","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d7d4f729-28af-4303-b466-4bf94d403f7e","type":"text/javascript","exec":[""]}}],"_postman_id":"834e3ea7-02a5-43dc-bfc8-415ca25da46f"},{"name":"Identity","item":[{"name":"Verify Identity","event":[{"listen":"test","script":{"id":"e3802669-7fd1-45db-a685-385e84760ca7","exec":["var jsonData = JSON.parse(responseBody);","tests[\"Status code is 201\"] = responseCode.code === 201;","postman.setGlobalVariable(\"identity_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"782ffae4-a436-4e95-93e3-f31458766f87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"candidateId\": \"{{candidate_id}}\",\n \"type\": \"kba\"\n}"},"url":"{{host}}/v1/identities","description":"File Requirements
\n\n
\n- \n
The maximum file size is 10MB. Files larger than 10MB will result in a 413 error response.
\n- \n
Files must be in
\n
Request to verify an identity of a candidate.
\n","urlObject":{"path":["v1","identities"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"32910373-d5d3-44d2-a7d8-e35c0b191c8a","name":"Invalid Candidate","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"candidateId\": \"123124\",\n \"type\": \"kba\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/identities"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"143"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 22 May 2020 22:46:06 GMT"},{"key":"x-amzn-RequestId","value":"8c79834f-6b60-461e-8aea-3f9afc663d73"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"M9JnNEv9IAMF8yQ="},{"key":"Request-Id","value":"0a982b4e-32f6-49d5-bb69-cdf97b36716d"},{"key":"x-amzn-Remapped-Date","value":"Fri, 22 May 2020 22:46:06 GMT"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 798fb06c416f07d7eaba25e2728dc5ac.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD79-C3"},{"key":"X-Amz-Cf-Id","value":"ofL15ib6XH7KmM06cujCItId_-hYpxAhF3mjzTt7oS9kW6jVYxuTFg=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400#candidateId?not-found\",\n \"message\": \"candidateId must be a valid candidateId associated with the authenticated account\"\n }\n ]\n}"},{"id":"3905247e-0f11-44e6-a25e-89e1ae693484","name":"Verify Identity","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"candidateId\": \"123124\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/identities"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 03 May 2019 18:19:02 GMT"},{"key":"x-amzn-RequestId","value":"e5b23541-6dcf-11e9-a2af-cf47e662a084"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZHnhaEm1oAMF8wA="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccc8609-7828dff44d8c97c0bbc282e2"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 d5a6610c68af624ff3a6a9cdee479708.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"pCNMzxo_Ogg1GO3GnfdwUKf9LeqIfeCNI_K6tBfCzwFh41m6m2qkaA=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1123123\",\n \"candidateId\": \"123124\",\n \"status\": \"pending\",\n \"kba\": {\n \"questions\": [\n {\n \"id\": \"1\",\n \"prompt\": \"What's your favorite number?\",\n \"answers\": [\n \"14\",\n \"42\",\n \"tau\",\n \"e\",\n \"planck's constant\"\n ]\n },\n {\n \"id\": \"2\",\n \"prompt\": \"Where do you live?\",\n \"answers\": [\n \"mercury\",\n \"venus\",\n \"earth\",\n \"mars\",\n \"oort cloud\"\n ]\n }\n ]\n }\n}"},{"id":"957bd7b5-df7d-4aa2-a956-d5d5c71b643c","name":"Candidate Has Existing Identity Record","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"candidateId\": \"988294079\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/identities"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"92"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 03 May 2019 18:50:09 GMT"},{"key":"x-amzn-RequestId","value":"3f211de6-6dd4-11e9-95a4-f7e27e031d1d"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZHsFTFvJoAMFYnA="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccc8d55-7d28806759c69a94a9308ff4"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 f082203290ecd8aea497e1bd9f2f6ebc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"VfuecDt2U1JXFF-z-GSWP883qZXjqkw3E17l82TrDawHKhk-1R2Tqg=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400#candidateId\",\n \"message\": \"Candidate already has an identity record\"\n }\n ]\n}"}],"_postman_id":"782ffae4-a436-4e95-93e3-f31458766f87"},{"name":"Retrieve Identity","id":"7babeff2-00ec-4595-a14b-b079e81acfb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"url":"{{host}}/v1/identities/{{identity_id}}","description":"Fetch the identity using a unique id.
Retry an identity check with its given id.
Provide the candidate's answers to their identity questions. This will determine whether the candidate is verified or not based on their answers. These questions are set in GET identity.
Request Body Fields
\n","urlObject":{"path":["v1","identities","{{identity_id}}","verification"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"a4d4ff89-b055-4629-a4c4-40b1ae364617","name":"Expired Questions","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"kba\": {\n \"questions\": [\n {\n \"prompt\": \"With which name are you associated?\",\n \"id\": \"1\",\n \"answers\": [\n \"NOBLE\",\n \"NEFF\",\n \"NAGANO\",\n \"None of the above\"\n ]\n },\n {\n \"prompt\": \"When did you purchase the property at PEACHTREE PLACE?\",\n \"id\": \"2\",\n \"answers\": [\n \"June 1999\",\n \"August 1999\",\n \"April 2000\",\n \"None of the above\"\n ]\n },\n {\n \"prompt\": \"From whom did you purchase the property at 222333 PEACHTREE PLACE?\",\n \"id\": \"3\",\n \"answers\": [\n \"ANDREW SCHWARZ\",\n \"JOE ANDERSON\",\n \"STEVE. REIFEL\",\n \"None of the above\"\n ]\n }\n ],\n \"answers\": [\n {\n \"questionId\": \"1\",\n \"response\": \"NOBLE\"\n },\n {\n \"questionId\": \"2\",\n \"response\": \"June 1999\"\n },\n {\n \"questionId\": \"3\",\n \"response\": \"ANDREW SCHWARZ\"\n }\n ]\n }\n}"},"url":"{{host}}/v1/identities/4627/verification"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"354"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 03 May 2019 19:08:35 GMT"},{"key":"x-amzn-RequestId","value":"d3a0f20b-6dd6-11e9-bad4-0b4142d7f43e"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZHuycEXzIAMFUgQ="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccc91a9-b6418e8e7a1617649a5b6e58"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 68bb623bd1a01bfb6607a40643084c92.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"dQIAwANHF3KkIXLZKNxkx33crDKi2focAHF6EFL9assBD78NGJMo1Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"422#expired\",\n \"message\": \"Questions for identity {{identityId}} have expired. Please initiate a retry using /identities/{{identityId}}/retry\"\n }\n ]\n}"},{"id":"e3e01410-3a36-4fc7-8090-12896075b183","name":"Answer Verification Questions","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"kba\": {\n \"questions\": [\n {\n \"prompt\": \"In which county have you lived?\",\n \"id\": \"1\",\n \"answers\": [\n \"DIVIDE\",\n \"FULTON\",\n \"MARSHALL\",\n \"None of the above\"\n ]\n },\n {\n \"prompt\": \"Between 1999 and 2002, in which State did you live?\",\n \"id\": \"2\",\n \"answers\": [\n \"MISSOURI\",\n \"NEW YORK\",\n \"OKLAHOMA\",\n \"None of the above\"\n ]\n },\n {\n \"prompt\": \"What type of residence is 4545 MAPLE VIEW PLACE?\",\n \"id\": \"3\",\n \"answers\": [\n \"Single Family Residence\",\n \"Apartment\",\n \"Condominium\",\n \"None of the above\"\n ]\n }\n ],\n \"answers\": [\n {\n \"questionId\": \"1\",\n \"response\": \"FULTON\"\n },\n {\n \"questionId\": \"2\",\n \"response\": \"NEW YORK\"\n },\n {\n \"questionId\": \"3\",\n \"response\": \"Single Family Residence\"\n }\n ]\n }\n}"},"url":"{{host}}/v1/identities/867/verification"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"354"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 03 May 2019 19:08:35 GMT"},{"key":"x-amzn-RequestId","value":"d3a0f20b-6dd6-11e9-bad4-0b4142d7f43e"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZHuycEXzIAMFUgQ="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccc91a9-b6418e8e7a1617649a5b6e58"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 68bb623bd1a01bfb6607a40643084c92.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"dQIAwANHF3KkIXLZKNxkx33crDKi2focAHF6EFL9assBD78NGJMo1Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"867\",\n \"candidateId\": \"1191285\",\n \"status\": \"verified\"\n}"}],"_postman_id":"1e5e9394-6b66-4e27-99bb-75295e355c84"}],"id":"fa0dfd50-c004-4268-8450-2fcb5dba9608","description":"The /identities resource allows Sterling to verify the identity of a user. In the context of the Sterling API, identity verification is one prerequisite for granting trusted status.
Unlike a background screening, identity verification does not imply that the individual has passed a background check. Instead, identity verification allows a user to establish that the candidate is who they say they are.
\n\n\n","event":[{"listen":"prerequest","script":{"id":"ab5c4541-f887-45ad-8f09-621634f803b7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f56f5497-ac1b-4a0a-9312-df313d84e902","type":"text/javascript","exec":[""]}}],"_postman_id":"fa0dfd50-c004-4268-8450-2fcb5dba9608"},{"name":"Trust","item":[{"name":"Create Trust","event":[{"listen":"test","script":{"id":"e24b9800-d5b8-49e4-beb8-b05f8d40112e","exec":["var jsonData = JSON.parse(responseBody);","tests[\"Status code is 201\"] = responseCode.code === 201;","postman.setGlobalVariable(\"trust_id\", jsonData.id);"],"type":"text/javascript"}}],"id":"110b6364-fc72-4a9c-a1c1-70063272d217","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"identityId\": \"{{identity_id}}\"\n}"},"url":"{{host}}/v1/candidates/{{candidate_id}}/trust","description":"Identity Retries and Offline Verification
\nIf the candidate fails after these attempts, an offline verification method is >highly recommended through your support teams. If a candidate is verified in this >manner, a
\nPOSTto/identitiesdoes not have to be made.We require the allocation of three attempts for candidates to complete their >identity verification before failing over to a manual approach.
\n
Create trust for a trusted candidate with their given candidate_id.
Request Body Fields
\n","urlObject":{"path":["v1","candidates","{{candidate_id}}","trust"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"14145fbc-d495-4a46-8963-2bd66b40a340","name":"Create Trust","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"identityId\": \"867\"\n}"},"url":"{{host}}/v1/candidates/1191285/trust"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"32"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 03 May 2019 20:19:59 GMT"},{"key":"x-amzn-RequestId","value":"ccf0b6b6-6de0-11e9-b701-75b553bc0bcf"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZH5PxH39IAMFwww="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccca264-b329453387b923f75c21b9ef"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 3fe062e94df57e4dee2ade20002471d5.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"gWocDPJpzgcpPwrmlFVm11V_JX_nc-0UMFxqDota-y0uAgc56NKp8Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"4636\",\n \"identityId\": \"867\"\n}"},{"id":"e8d9f0f5-9e2b-4bd3-be1c-b1e88cdc75f5","name":"Trust Already Exists","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"identityId\": \"867\"\n}"},"url":"{{host}}/v1/candidates/1191285/trust"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"104"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 03 May 2019 20:27:21 GMT"},{"key":"x-amzn-RequestId","value":"da9fddf9-6de1-11e9-a1c7-bfbcf2a0f454"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZH6WeHS-IAMF11Q="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5ccca429-8b806edac5c9652c2a6c6f40;Sampled=0"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 b2566c33186e0b7da4759cb2082b0f5d.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"5kY5_XvUAeGqeZq6jKbDmRcpKdjDX4nmJimX0mWs1qtNfceQhULrPA=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400#identityId\",\n \"message\": \"Trusted identifier already assigned to this candidate\"\n }\n ]\n}"}],"_postman_id":"110b6364-fc72-4a9c-a1c1-70063272d217"},{"name":"Lookup Trust","id":"07f3e2fc-d810-4b53-b80d-67ecf3d2db38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"url":"{{host}}/v1/trusted-users/{{trust_id}}","description":"Lookup a trusted candidate by trust_id.
Revoke trust from a trusted user by trust_id.
When a trust has been revoked from a trusted user, passing the trust trust_id to this PUT endpoint will re-enable that trust.
Once a candidate has passed identity verification, the candidate can be granted trust. An application can then submit screening requests on behalf of the trusted user. This trust, along with a permissible purpose, allows the trusted user to review the screening report and approve or reject the candidate for that purpose.
\nTrust can be revoked by making a request to the DELETE endpoint.
GET request to list reference codes associated with the API account.
GET request to retrieve the billing codes associated with the API account.
A pair of GETs for billing-codes and reference-codes, respectively, are available to allow for the listing of existing billing or reference codes available to your account.
Add a global webhook for all screenings.
\nRequest Body Fields
\n","urlObject":{"path":["v1","config","webhooks"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"8a4c52ec-8b28-4a60-b3d6-761601f91ac5","name":"Create Webhook","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"uri\": \"https://www.example.com\",\n \"credentials\": {\n \"basic-auth\": \"base64-encoded-credentials\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/config/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"84"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 03 May 2019 21:05:01 GMT"},{"key":"x-amzn-RequestId","value":"17870bba-6de7-11e9-91a7-b7ed13cf3305"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZH_1_H90IAMFnTQ="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5cccacf3-2d7106c0845e4320bc605520"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 23d2c4964d6868e014bfe491b62d3f2f.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"SYzhNolTzmstM56MoLF0OrI-nnYaVv3Wj72pYvCJ-xhKqSpVnkMHYg=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"432153\",\n \"uri\": \"https://www.example.com\",\n \"credentials\": {\n \"basic-auth\": \"base64-encoded-credentials\"\n }\n}"},{"id":"c4362668-21f9-4c46-af02-6cc68bc8a34b","name":"Bad URI","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"uri\": \"http://www.example.com\",\n \"credentials\": {\n \"basic-auth\": \"base64-encoded-credentials\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/config/webhooks"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"80"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 03 May 2019 21:06:37 GMT"},{"key":"x-amzn-RequestId","value":"50da3005-6de7-11e9-b161-090ef9f790f6"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZIAFAHytIAMFnQQ="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5cccad53-283bf3c831ff1085a59af7c9"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 23d2c4964d6868e014bfe491b62d3f2f.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"LkFx6KQVhXEXyJamXHdM64s4ITGJ3Oj2J7UA5PspGYkjekvfg_QyrQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400#uri?format\",\n \"message\": \"uri must be a valid https url\"\n }\n ]\n}"},{"id":"cb3d099c-00cf-431a-ae20-1dbccbb74002","name":"Webhook Already Exists","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"uri\": \"https://www.example.com\",\n \"credentials\": {\n \"basic-auth\": \"base64-encoded-credentials\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/config/webhooks"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"84"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 03 May 2019 21:07:11 GMT"},{"key":"x-amzn-RequestId","value":"6538e054-6de7-11e9-b442-978d8415e8cb"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"x-amz-apigw-id","value":"ZIAKWEBzoAMFyCg="},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Amzn-Trace-Id","value":"Root=1-5cccad75-95fba564d34aea0c8a72a728"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 23d2c4964d6868e014bfe491b62d3f2f.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"sFNlAVrsGIgjCCrp1qdg7pDBwJBQLMS3cGD-8aVnUXe1mRqY5ULDBg=="}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"400\",\n \"message\": \"Currently restricted to one webhook per user\"\n }\n ]\n}"}],"_postman_id":"9b2862a0-289b-44a6-80c6-b57781cc0683"},{"name":"Get Webhook","id":"228140ff-cc02-4d2d-9ee9-1d95fb98c035","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"url":"{{host}}/v1/config/webhooks/{{webhook_id}}","description":"Lookup an existing webhook by webhook_id.
Configure an existing webhook by webhook_id.
Request Body Fields
\n","urlObject":{"path":["v1","config","webhooks","{{webhook_id}}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"21d12c1c-3973-45b0-84b0-e36c9df7ca2c","name":"Update Webhook","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"uri\": \"www.exampl33e.com\",\n \"credentials\": {\n \"basic-auth\": \"asdbfxans44444\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/config/webhooks/432153"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"432153\",\n \"uri\": \"www.exampl33e.com\",\n \"credentials\": {\n \"basic-auth\": \"asdbfxans44444\"\n }\n}"}],"_postman_id":"9c4b3cb0-e170-475d-b0bf-08c0eb21394c"},{"name":"Delete Webhook","id":"1153a888-ea1c-459e-a575-a7a40f430eb6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}"}],"body":{"mode":"raw","raw":""},"url":"{{host}}/v1/config/webhooks/{{webhook_id}}","description":"Remove an existing webhook by webhook_id.
In some cases you may want to collect data for every screening on one endpoint. Webhooks provide this capability and will include additional information apart from just screening updates
\nAny number of Webhook endpoints can be created and begin with a simple POST request.
Upon creation of the Webhook, any and all screening updates will be posted to the URI provided in the payload.
\n","event":[{"listen":"prerequest","script":{"id":"d43dd0d6-4a9c-43e6-a94b-82a33ae2169f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"711ce1fa-133f-41e6-987c-e437f259b739","type":"text/javascript","exec":[""]}}],"_postman_id":"35fc32ef-4b26-4560-a6bc-fe0d91cbaeaa"}],"id":"63208c4e-983d-446f-818d-9566c8262414","_postman_id":"63208c4e-983d-446f-818d-9566c8262414","description":""},{"name":"Objects","item":[{"name":"Address","item":[],"id":"7d9ba53f-3ef7-4eb2-8cfa-12e46b175df9","description":"This is the address of the candidate.
\nJSON Example
\naddress\": {\n \"addressLine\": \"123 PEACHTREE PLACE\",\n \"municipality\": \"ATLANTA\",\n \"regionCode\": \"US-GA\",\n \"postalCode\": \"12345\",\n \"countryCode\": \"US\"\n}\nThis is the candidate's driver's license.
\nJSON Example
\n\"driversLicense\": {\n \"type\": \"personal\",\n \"licenseNumber\": \"S1234567\",\n \"issuingAgency\": \"CA\"\n}\nAlternate information the candidate may also be known by.
\nJSON Example
\n\"aliases\": [\n {\n \"givenName\": \"GivenAlias1\",\n \"familyName\": \"FamilyNameAlias1\",\n \"middleName\": \"MiddleNameAlias1\",\n \"confirmedNoMiddleName\": false\n },\n {\n \"givenName\": \"GivenAlias2\",\n \"familyName\": \"FamilyNameAlias2\",\n \"confirmedNoMiddleName\": true\n }\n]\nThis is the url where webhook notifications should be posted for this screening. Please refer to Callbacks for more details.
\nJSON Example
\n\"callback\": {\n \"uri\": \"https://my-company.com/screenings-callback\",\n \"credentials\": {\n \"basic-auth\": \"base64-encoded-credentials\"\n }\n}\nAuth credentials for callback authentication.
\nJSON Example
\n\"credentials\": {\n \"basic-auth\": \"base64-encoded-credentials\"\n}\n