;

GDPR Data Masking Service

This API processes GDPR requests to mask data associated with a candidate based on your account. It follows GDPR data removal guidelines and applies to records tied to the provided email address or a specific test attempt (TestInvitationId).
Usage Scenarios:

1. Mask All Records: To mask all records associated with a candidate, provide only the CandidateEmail parameter.

2. Mask Specific Record: To target a specific record, provide both CandidateEmail and TestInvitationId.

POST https://apiv3.imocha.io/v3/gdpr/requests
  • Docs
Request Body Parameters
Field Type Required Default Description
CandidateEmail String Yes - Candidate email address
testinvitationId Integer64 No - testinvitationId -unique identifier given to each test attempt
Example API endpoint

URL 1: /v3/gdpr/requests

Scenario 1: Sample Request Body 
Request Body

                                    
    {

      "CandidateEmail":"[email protected]"
     
    }
Scenario 2: Sample Request Body 
Request Body

                                    
    {

      "CandidateEmail":"[email protected]",
      "testinvitationId":2346542

    }
Successful response

Status 200 OK

Response

                                    
    {
         "result": "Request accepted for processing"
    }
Failed response

Status 400 Bad Request

If required parameters have invalid values.

Response

                                    

 {
    "errors": [
        "No records found for given Email address: [email protected]"
    ]
}
Parameter Value Description Parameter Type Data Type
testinvitationIds Unique identifier given to each test attempt

Note: Enter multiple testinvitationId seperated by a comma

 Body Array of Integer64
  • Response Body