---
updatedAt: 2026-05-28T05:27:12.000Z
agentTools:
  projectIndex: https://developers.smartrecruiters.com/llms.txt
---

# Request consent from multiple candidates

Read more about GDPR tools on [SmartRecruiters Help Center](https://customers.smartrecruiters.com/kb/articles/2273-compliance-and-gdpr-tools-for-companies)


# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "version": "1",
    "title": "Candidates API",
    "contact": {
      "name": "SmartRecruiters",
      "url": "https://developers.smartrecruiters.com"
    }
  },
  "tags": [
    {
      "name": "candidates"
    }
  ],
  "paths": {
    "/candidates/consent-requests": {
      "post": {
        "responses": {
          "201": {
            "description": "Consent requests has been scheduled.\n\nThe response contains a list of results for each individual consent request in the same order as in the request.\n\nA single result `status` property value could be:\n* 202 - consent request successfully scheduled,\n* 403 - cannot request consent from candidate as no privacy policy has been configured.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConsentRequestsResults"
                }
              }
            }
          }
        },
        "description": "Read more about GDPR tools on [SmartRecruiters Help Center](https://customers.smartrecruiters.com/kb/articles/2273-compliance-and-gdpr-tools-for-companies)\n",
        "tags": [
          "candidates"
        ],
        "summary": "Request consent from multiple candidates",
        "operationId": "candidates.consent.request.batch",
        "security": [
          {
            "key": []
          },
          {
            "oauth": [
              "candidates_manage"
            ]
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/BatchConsentRequest"
        }
      }
    }
  },
  "components": {
    "requestBodies": {
      "BatchConsentRequest": {
        "required": true,
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "content"
              ],
              "properties": {
                "content": {
                  "type": "array",
                  "minItems": 1,
                  "maxItems": 1000,
                  "items": {
                    "$ref": "#/components/schemas/ConsentRequest"
                  }
                }
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "key": {
        "type": "apiKey",
        "in": "header",
        "name": "x-smarttoken"
      },
      "oauth": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://www.smartrecruiters.com/identity/oauth/allow",
            "tokenUrl": "https://api.smartrecruiters.com/identity/oauth/token",
            "scopes": {
              "candidates_read": "Access Candidates",
              "candidates_create": "Create Candidates",
              "candidates_offers_read": "Access Offer Terms",
              "candidates_manage": "Manage Candidate Status and Properties",
              "candidate_status_read": "Access Candidate's status",
              "candidates_parse_resume": "Access Resume Parsing"
            }
          }
        }
      }
    },
    "schemas": {
      "ConsentRequest": {
        "type": "object",
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "description": "candidate id",
            "type": "string"
          }
        }
      },
      "ConsentRequestsResults": {
        "type": "object",
        "required": [
          "results"
        ],
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/ConsentRequestScheduled"
                },
                {
                  "$ref": "#/components/schemas/ConsentRequestUnavailable"
                }
              ]
            }
          }
        }
      },
      "ConsentRequestScheduled": {
        "type": "object",
        "required": [
          "status",
          "body"
        ],
        "properties": {
          "status": {
            "type": "integer",
            "enum": [
              202
            ]
          },
          "body": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string"
              }
            }
          }
        }
      },
      "ConsentRequestUnavailable": {
        "type": "object",
        "required": [
          "status"
        ],
        "properties": {
          "status": {
            "type": "integer",
            "enum": [
              403
            ]
          },
          "body": {
            "type": "boolean",
            "enum": [
              false
            ]
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.smartrecruiters.com"
    }
  ]
}
```