> For the complete documentation index, see [llms.txt](https://docs.vcheckglobal.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vcheckglobal.com/api-reference/background-check/background-check-orders.md). # Background Check Orders Submit and update background check orders. ## Submit Order > Submit a Background Check order. A \`202 Accepted\` response means the order has been queued\ > successfully - processing is asynchronous. You will receive results via webhook or can\ > retrieve the report once complete.\ > \ > \## Subject Types\ > \ > Every order has a \`subject\_type\`: \`Individual\` (default) or \`Entity\` (a company).\ > \ > \| Field | Individual | Entity |\ > \|---|---|---|\ > \| \`subject\_type\` | optional (\`Individual\`) | \`"Entity"\` |\ > \| \`first\_name\` | required | omit; ignored if sent |\ > \| \`last\_name\` | required (surname) | required (company name) |\ > \| \`email\` | required | optional |\ > \| \`state\_of\_formation\` | not used | required - state full name, e.g. \`Delaware\` |\ > \| \`reference\_id\` | required | required |\ > \| \`product\_code\` | required | required |\ > \| \`dob\`, \`ssn\` | optional | optional; stored when provided |\ > \ > An Entity order covers the company only. C-suite members are separate orders under the same\ > project when they are ordered.\ > \ > \### Submit an Entity order\ > \ > \`\`\`json\ > {\ > "subject\_type": "Entity",\ > "last\_name": "Acme Holdings LLC",\ > "state\_of\_formation": "Delaware",\ > "reference\_id": "REF-0000-00002",\ > "product\_code": "BGC\_STANDARD"\ > }\ > \`\`\`\ > \ > \`email\` is optional for an Entity. When it is omitted, the duplicate-email check is skipped.\ > \`state\_of\_formation\` is matched case-insensitively against the state catalogue by full name.\ > An unknown value returns \`400\`. It is stored in the portal and is not sent to Salesforce.\ > \ > \## Errors\ > \ > A \`400\` returns \`{"detail": "\"}\`. The message names every field that failed, for\ > example:\ > \ > \*\*Deduplication:\*\* \`reference\_id\` must be unique per account. \`email\` must be unique per\ > account when provided.\ > \ > \*\*Required scope:\*\* \`api-platform/backgroundcheck-read-write\`. A token with only\ > \`api-platform/backgroundcheck-read\` receives a \`403 Forbidden\`.\ > \ > \*\*Note:\*\* Orders cannot be modified once submitted. Contact with\ > the \`reference\_id\` if corrections are needed.
````json {"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Background Check Orders","description":"Submit and update background check orders."}],"servers":[{"url":"https://api-platform.vcheckglobal.net/v2","description":"Vcheck platform (sandbox host issued first; production host after sign-off)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Obtain a token via POST https://api-platform.vcheckglobal.net/v2/oauth2/token.\nInclude in all subsequent requests as `Authorization: Bearer `.\nTokens expire after 3,600 seconds - cache and reuse; request a new one only when close to expiry.\n"}}},"paths":{"/backgroundcheck/request":{"post":{"tags":["Background Check Orders"],"operationId":"submitBgcOrder","summary":"Submit Order","description":"Submit a Background Check order. A `202 Accepted` response means the order has been queued\nsuccessfully - processing is asynchronous. You will receive results via webhook or can\nretrieve the report once complete.\n\n## Subject Types\n\nEvery order has a `subject_type`: `Individual` (default) or `Entity` (a company).\n\n| Field | Individual | Entity |\n|---|---|---|\n| `subject_type` | optional (`Individual`) | `\"Entity\"` |\n| `first_name` | required | omit; ignored if sent |\n| `last_name` | required (surname) | required (company name) |\n| `email` | required | optional |\n| `state_of_formation` | not used | required - state full name, e.g. `Delaware` |\n| `reference_id` | required | required |\n| `product_code` | required | required |\n| `dob`, `ssn` | optional | optional; stored when provided |\n\nAn Entity order covers the company only. C-suite members are separate orders under the same\nproject when they are ordered.\n\n### Submit an Entity order\n\n```json\n{\n \"subject_type\": \"Entity\",\n \"last_name\": \"Acme Holdings LLC\",\n \"state_of_formation\": \"Delaware\",\n \"reference_id\": \"REF-0000-00002\",\n \"product_code\": \"BGC_STANDARD\"\n}\n```\n\n`email` is optional for an Entity. When it is omitted, the duplicate-email check is skipped.\n`state_of_formation` is matched case-insensitively against the state catalogue by full name.\nAn unknown value returns `400`. It is stored in the portal and is not sent to Salesforce.\n\n## Errors\n\nA `400` returns `{\"detail\": \"\"}`. The message names every field that failed, for\nexample:\n\n**Deduplication:** `reference_id` must be unique per account. `email` must be unique per\naccount when provided.\n\n**Required scope:** `api-platform/backgroundcheck-read-write`. A token with only\n`api-platform/backgroundcheck-read` receives a `403 Forbidden`.\n\n**Note:** Orders cannot be modified once submitted. Contact support@vcheckglobal.com with\nthe `reference_id` if corrections are needed.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["last_name","reference_id","product_code"],"properties":{"subject_type":{"type":"string","enum":["Individual","Entity"],"default":"Individual","description":"Subject type. `Individual` (default) or `Entity` (a company). For an `Entity`, put the company name in `last_name` and supply `state_of_formation`. `Entity` is company-only; C-suite members are separate orders."},"first_name":{"type":"string","maxLength":150,"description":"Subject first name. Required for an `Individual`. Omit for an `Entity`; when sent for an `Entity` it is ignored (the company name is `last_name`)."},"last_name":{"type":"string","maxLength":150,"description":"Subject last name for an `Individual`, or the company name for an `Entity`."},"email":{"type":"string","format":"email","description":"Subject email. Required for an `Individual`. Optional for an `Entity`. When provided it must be unique per account - it is the primary deduplication identifier. When omitted for an `Entity`, the duplicate check is skipped."},"state_of_formation":{"type":"string","maxLength":255,"description":"State of formation. Required for an `Entity`. Matched case-insensitively against the state catalogue by full name (e.g. `Delaware`). An unknown value returns `400`. Not sent to Salesforce."},"reference_id":{"type":"string","maxLength":100,"description":"Your unique reference for this order. Must be unique per account."},"product_code":{"type":"string","maxLength":128,"description":"Product code from GET /backgroundcheck/products."},"requestor":{"type":"string","format":"email","description":"Email of a registered VCheck portal user. Defaults to account default contact if omitted."},"participants":{"type":"array","items":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email"}}},"description":"List of {\"email\": \"...\"} objects. Receive email notifications for this subject."},"turnaround_time":{"type":"string","enum":["Standard","Rush"],"default":"Standard","description":"Standard (default) or Rush."},"phone_number":{"type":"string","maxLength":20,"description":"Subject phone number. E.164 format recommended."},"country":{"type":"string","description":"Subject country. ISO 3166-1 alpha-2 (e.g. US, GB)."},"dob":{"type":"string","maxLength":10,"description":"Subject date of birth. Format: MM/DD/YYYY. Optional for an `Entity`; stored when provided."},"ssn":{"type":"string","maxLength":256,"description":"Subject SSN. Format: XXX-XX-XXXX. PII - encrypted at rest. Optional for an `Entity`; stored when provided."},"corporate_url":{"type":"string","format":"uri","maxLength":2048,"description":"Subject's corporate or professional profile URL."},"linkedin_url":{"type":"string","format":"uri","maxLength":2048,"description":"Subject's LinkedIn profile URL."}},"allOf":[{"if":{"properties":{"subject_type":{"const":"Individual"}}},"then":{"required":["first_name","email"]}},{"if":{"properties":{"subject_type":{"const":"Entity"}}},"then":{"required":["state_of_formation"]}}],"additionalProperties":false}}}},"responses":{"202":{"description":"Order accepted and queued for processing.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}},"400":{"description":"Validation failed during the pre-validation step (called automatically before queuing).\nReturns `{\"detail\": \"\"}`. The message names every field that failed, so no missing\nfield is hidden. Possible causes: missing or invalid fields, an Entity without\n`state_of_formation`, an unknown `state_of_formation`, duplicate email (when an email is\nprovided), product not found or not allotted to the account, or an invalid requestor.\n","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Forbidden - missing or invalid `Client-ID` credentials, insufficient scope, or the endpoint is disabled. This endpoint requires `api-platform/backgroundcheck-read-write`; a read-only token is not sufficient.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}},"500":{"description":"Internal server error - an unexpected error occurred. Please try again later or contact support if the issue persists.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}}}}}}} ```` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.vcheckglobal.com/api-reference/background-check/background-check-orders.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.