{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"f5ab46dc-665c-44a0-9a0a-04e1a16a311a","name":"SpringVerify India — BGV API","description":"\n# SpringVerify BGV API\n\nSpringVerify runs Background Verification (BGV) for employers. This collection is the whole\nintegration: create a candidate, submit their details, track the checks, and pull the finished\nreport.\n\nEvery request carries its own reference documentation and saved example responses — including the\nerrors you will actually hit — so you can read this as an API reference and run it as a working\nclient.\n\n---\n\n## The flow\n\n```\n  1. GET  /packages          Discover packages, required fields, categories,\n         |                   tags, custom fields, add-on catalogue\n         v\n  2. POST /add               Create the candidate -> candidate_id\n         |                   (resume by URL or base64; add-ons; category; tags)\n         v\n  3. POST /v2/submit-bgv     Submit check data\n         |                   (on a validation error: fix the payload and resend)\n         v\n  4. GET  /details           Poll status until it reaches a final state\n         |\n         v\n  5. GET  /report/pdf        Download the completed report\n```\n\nThe requests are in that order. Add candidate and Submit BGV each appear twice — once sending files as\nhosted URLs, once sending them inline as base64 — because those are the two file mechanisms the API\nsupports. Pick whichever suits you; the rest of each payload is identical.\n\nRun them top to bottom and the collection chains itself: `subtype_id` and `candidate_id` are captured\nfrom the responses into collection variables, so you rarely need to paste an id by hand.\n\n---\n\n## Sending files: URL or base64\n\nEvery file the API accepts can be sent one of two ways, and you choose per file:\n\n| Mechanism | How | When to use it |\n|---|---|---|\n| **Hosted URL** | `\"resume\": \"https://…\"` · `\"documents\": [{ \"url\": \"https://…\" }]` | You already host the file somewhere reachable. SpringVerify downloads it and re-hosts it, so the link only has to work at the moment of the call. Cheaper for large or numerous files. |\n| **Inline base64** | `\"resume\": { content, content_type, name }` · `\"documents\": [{ content, content_type, name }]` | You hold the bytes but cannot expose a public link. |\n\nRules that apply to both:\n\n- A `documents[]` entry is **either** hosted or inline — never both keys in one entry. You may mix\n  entries freely within a request.\n- `content_type` is **mandatory** with `content`. Nothing is inferred; a résumé is never assumed to be\n  a PDF.\n- Hosted URLs must be `https` for the résumé (plain `http` is rejected) and must not redirect.\n- Size caps are measured **after** decoding: 20 MB per résumé, and the submit call's document limits\n  apply per file.\n\n**One exception: the consent document is URL-only.** `candidate.consent` on add and `consent.doc_url`\non submit both take a URL and have no inline form. If you cannot host it, ask SpringVerify to move\nyour company to the `UNDERTAKING_LETTER` consent model — then there is no per-candidate document at\nall and you simply send `is_consent_undertaking_letter: true`.\n\n---\n\n## Webhook callbacks\n\nRather than polling **Get candidate details**, SpringVerify can call **you** when a candidate reaches\na final status.\n\n**Setup is on our side.** Send your point of contact the callback URL, the auth scheme you want, and\nany static headers, and we configure it — there is nothing to call here, and no self-serve\nsubscription API yet.\n\nWe POST a JSON body shaped like this:\n\n```json\n{\n  \"event\": \"completed\",\n  \"candidate_id\": 33447,\n  \"candidate_uuid\": \"636969e2-7587-4f01-bd4c-e9097c1389ca\",\n  \"overall_status\": \"Completed\",\n  \"overall_status_code\": 1,\n  \"name\": \"Jane Doe\",\n  \"email\": \"jane.doe@example.com\",\n  \"employee_id\": \"EMP-1001\",\n  \"report_url\": \"https://…signed-s3-url…\",\n  \"completed_date\": \"2026-07-29T11:04:22.000Z\",\n  \"meta_data\": { \"requisition_id\": \"REQ-1\" }\n}\n```\n\n- `meta_data` is whatever you sent on Add candidate, so you can correlate against your own record\n  without a lookup.\n- `report_url` is a **signed URL that expires** — download it promptly rather than storing the link.\n- Auth options: `none`, `basic`, `bearer`, `api_key` (a header you name), or `hmac` (a signature over\n  the raw body, default header `X-SpringVerify-Signature`).\n- **Respond `200`, `201`, `202` or `204`.** Anything else is retried on the next cycle, and returning\n  `401`/`403` for a transient problem disables your endpoint until setup is re-run.\n- Be idempotent — key on `candidate_id` + `overall_status_code`.\n\nPushes are batched on a schedule, not fired the instant a status changes, so treat the webhook as an\noptimisation. Get candidate details always holds the same information, and a periodic reconciliation\nsweep against it is recommended.\n\n---\n\n## Getting started\n\n1. Ask your SpringVerify point of contact for a **sandbox host and API token**.\n2. Import the environment that ships with this collection, or set the variables below.\n3. Run **Get packages**. That single call tells you which packages, fields, tags, categories and\n   add-ons exist for your company.\n4. Work down the list.\n\n| Variable | What it is |\n|---|---|\n| `base_url` | Sandbox: `https://api-acceptance-2-sa.in.springverify.com` · Production: `https://api-sa.in.springverify.com` |\n| `api_token` | Your bearer token. Environment-specific. |\n| `subtype_id` | Captured from Get packages. Identifies the package you are ordering. |\n| `candidate_id` | Captured from Add candidate. |\n\n---\n\n## Authentication\n\nBearer token, set once on the collection and inherited by every request:\n\n```\nAuthorization: Bearer <YOUR_API_TOKEN>\nContent-Type: application/json\n```\n\nThe token identifies your company, so **you never send a company id**. It is long-lived — treat it\nas a secret. No IP allow-listing is required.\n\nA missing, invalid or expired token returns `401` in a distinct shape:\n\n```json\n{ \"msg\": \"Token is missing\", \"description\": \"Bearer token in headers is required\" }\n```\n\n---\n\n## Sandbox and production\n\n| Environment | Host |\n|---|---|\n| Sandbox | `https://api-acceptance-2-sa.in.springverify.com` |\n| Production | `https://api-sa.in.springverify.com` |\n\nA token belongs to exactly one environment. Package ids, category ids, tag ids and custom field ids\nalso differ between the two, so when you go live switch the host **and** the token, then re-read\nGet packages. Never carry ids across environments.\n\n---\n\n## Error handling\n\nErrors are JSON with a status and a human-readable message. Validation failures also name the\noffending fields.\n\n| Code | Retry? | Meaning |\n|---|---|---|\n| `400` | No | Malformed request, or a field failed validation. |\n| `401` | No | Token missing, invalid or expired. |\n| `404` | No | Candidate, report or custom field not found. |\n| `409` | No | Duplicate candidate, or the candidate is not in the state the call requires. |\n| `413` | No | Payload too large — 20 MB résumé, 30 MB document bundle. |\n| `422` | No | Submitted data does not match the package, or a file type is not allowed. |\n| `429` | Yes | Back off and retry. There are no published rate limits. |\n| `5xx` | Yes | Temporary server issue. Retry with exponential backoff. |\n\nSubmit BGV returns every problem at once, each entry naming the field **exactly as you sent it**:\n\n```json\n{\n  \"success\": false,\n  \"message\": \"Error during form submission\",\n  \"errors\": [\n    { \"field\": \"identity.identity_1.id_type\", \"error\": \"id_type must be one of: PAN, PASSPORT, DL, VOTER_ID, AADHAAR\" }\n  ]\n}\n```\n\n---\n\n## Known behaviours\n\nDocumented so you do not design around them.\n\n| Area | Behaviour | Work-around |\n|---|---|---|\n| `category_id` on Add candidate | Accepted and validated, but not returned by the details call. | Use `tags`, or carry your value in `meta_data`. |\n| UPPERCASE add-on keys | Accepted with `200`, but stored as a custom check; the candidate's submit then fails with a `500`. | Send add-on keys in **lowercase** — `employment`, not `EMPLOYMENT`. |\n| `skipped_checks` as an array | Ignored; the skip has no effect. | Send it as an object: `{ \"employment_check\": 1 }`. |\n\n---\n\n*Companion guide: **SpringVerify BGV API — Integration Guide v3.2**. Ask your point of contact if\nyou do not have it.*\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"20577685","team":3383279,"collectionId":"f5ab46dc-665c-44a0-9a0a-04e1a16a311a","publishedId":"2sBY4Wnbc3","public":true,"publicUrl":"https://documenter-api.postman.tech/view/20577685/2sBY4Wnbc3","privateUrl":"https://go.postman.co/documentation/20577685-f5ab46dc-665c-44a0-9a0a-04e1a16a311a","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.6","publishDate":"2026-08-10T15:09:00.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"SpringVerify BGV API — Sandbox","id":"c56246d6-ad35-405f-9e59-4cee1f6ba802","owner":"20577685","values":[{"key":"base_url","value":"https://api-acceptance-2-sa.in.springverify.com","type":"default","enabled":true},{"key":"api_token","value":"","type":"secret","enabled":true},{"key":"subtype_id","value":"","type":"default","enabled":true},{"key":"candidate_id","value":"","type":"default","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/4eb3dd8d384a1ea5f49d1a4afaafb1c0386dc6e26b2f7c8d7e8a9d5c67e10533","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"SpringVerify BGV API — Sandbox","value":"20577685-c56246d6-ad35-405f-9e59-4cee1f6ba802"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBY4Wnbc3"}