View a Gdpr Request

GET /gdpr-requests/{id}
Copied
Arrow
                https://api.ocamba.com/v1/hood/gdpr-requests/{id}

Returns an instance of gdpr requests.

query Parameters
Arrow
Name
Description
fieldsstring
Fields parameter represents array of dimensions and measures. Dimensions are used to categorize, segment, and reveal the details of the data. Measures contain numeric, quantitative values that can be measured. At least one measure is required.


Example: fields=field1,field2,field3
viewstring
Hood API returns full representation of the resource using the "view=full" query parameter. If not specified, the default view will be used.

Note that the "fields" parameter has precedence over the "view" parameter.


Example: view=full/default
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /VERSION/hood/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/hood/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/hood/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,field2
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.


Example: page=1,10
q_fieldsstring
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /VERSION/hood/RESOURCE_NAME?q=sou&q_fields=lname → API retuns a certain resource whose lname contains string 'sou'.
GET /VERSION/hood/RESOURCE_NAME?q=sou&q_fields=fname,lname,email → API returns a certain resource that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.
qstring
Set the q parameter value to search for a keyword or search term.

Example:
GET /VERSION/hood/RESOURCE_NAME?q=sou → returns a certain resource that contain string 'sou'

See tips for the list of searchable parameters.
path Parameters
Arrow
Name
Description
idstringrequired
Unique resource identifier.


Example: 12345

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ gdpr-request ]
An array of all created items.
Gdpr Request
Name
Description
additional_informationstring
Optional additional information about the request. Maximum 2000 characters


Example: I also would like to have some non identifiable information removed.
client_idstring
A unique user identifier generated by the Ocamba platform.


Example: 17368658975598752000
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 7196310
create_timestring
Timezone: GMT.


Example: 2021-10-29 12:47:00
idstring
A unique identifier generated by the Ocamba platform.


Example: 1000023
information_to_removestring
Describes the type of data the user wishes to remove. Maximum 2000 characters.


Example: I wish to remove all indetifiable information about John Smith.
proof_of_addressstring
A link to the document containing proof of address of the requester. On creation provided as a file.


Example: https://storage.ocamba.com/7196310/hood/gdpr-request/17368658975598751634/proof_of_address.pdf
proof_of_identitystring
A link to the document containing proof of identity of the requester. On creation provided as a file.


Example: https://storage.ocamba.com/7196310/hood/gdpr-request/17368658975598751634/proof_of_identity.pdf
rejection_reasonstring
Provided reason for request denial. Required when updating status to denied. Maximum 500 characters.


Example: Proof of identity is not valid.
request_declarationobject

Name
Description
data_holder_namestring
Describes which entity is holding the data of the request subject.


Example: some-website.com
datestring
Describes a date when the declaration was signed. In YY-MMMM-DD format.


Example: 2025-01-21
signaturestring
Requester signature


Example: John Smith
requester_informationobject

Name
Description
addressstring
Address of a person who is making a request. Maximum 200 characters.


Example: 131 Acacia Avenue
emailstring
Email of a person who is making a request. Must follow the email format. Maximum 100 characters.


Example: [email protected]
full_namestring
Full name of a person who is making a request. Maximum 200 characters.


Example: John Smith
phone_numberstring
Phone number of a person who is making a request. Must comply with E164 standarad, maximum 20 characters.


Example: +13412313
statusstring
Describes the status of the request. On creation it is set to pending.


Example: pending

Possible values: pending | approved | denied
subject_informationobject

Name
Description
addressstring
Address of a request subject. Maximum 200 characters.


Example: 131 Acacia Avenue
emailstring
Email of a request subject. Must follow the email format. Maximum 100 characters.


Example: [email protected]
full_namestring
Full name of a request subject. Maximum 200 characters.


Example: John Smith
phone_numberstring
Phone numberof a request subject. Must comply with E164 standarad, maximum 20 characters.


Example: +13412313
submission_reasonstring
Provided reason for request submission.


Example: consent-withdrawal

Possible values: data-no-longer-necessary | consent-withrawal | article-21-gdpr | unlawful-processing | eu-legal-obligation | child-subject
update_timestring
Timezone: GMT.


Example: 2021-10-30 14:27:26
totalinteger
A total number of items.


Example: 1
400 - Bad Request
Arrow
Name
Description
codeinteger
Http response status code.


Example: 400
messagestring
The human readable message that describes how to deal with error.


Example: The request body is not valid.
titlestring
The error title.


Example: Bad request.
trace_idstring
Error trace id.


Example: 99a84211-f73d-4ff8-acdf-eb3e06bb9d62
500 - Internal Server Error
Arrow
Name
Description
codeinteger
Http response status code.


Example: 500
messagestring
The human readable message that describes how to deal with error.


Example: Internal server error.
titlestring
The error title.


Example: Internal server error.
tip
1 Sortable fields are: create_time and update_time.
2 Filterable fields are: client_id, status, create_time and update_time
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
  • 400
  • 500
{
  "total":1,
  "items":[
      {
        "id": "1000000",
        "company_id": "6197120",
        "client_id": "17371227395790007397",
        "status": "denied",
        "submission_reason": "consent-withdrawal",
        "rejection_reason": "Rejected because invalid proof of address was provided.",
        "requester_information": {
            "full_name": "Peter Dwayne",
            "address": "521 Oak Street",
            "phone_number": "+33126406",
            "email": "[email protected]"
        },
        "subject_information": {
            "full_name": "Dorothy Smith",
            "address": "251 7th Avenue",
            "phone_number": "+52321023",
            "email": "[email protected]"
        },
        "information_to_remove": "I wish to remove all identifying information about myself",
        "request_declaration": {
            "signature": "John Smith",
            "data_holder_name": "John's Data Emporium",
            "date": "2025-01-21"
        },
        "proof_of_address": "https://dev-storage.ocamba.com/6197120/hood/gdpr-request/17371227395790007397/proof-of-address/dummy.pdf",
        "proof_of_identity": "https://dev-storage.ocamba.com/6197120/hood/gdpr-request/17371227395790007397/proof-of-identity/dummy.pdf",
        "create_time": "2025-01-20 13:41:49",
        "update_time": "2025-01-20 14:00:44"
    }
  ]
}

{
  "total": 1,
  "items": [
    {
      "id": "1000023",
      "company_id": "7196310",
      "client_id": "17368658975598752000",
      "status": "pending",
      "submission_reason": "consent-withdrawal",
      "rejection_reason": "Proof of identity is not valid.",
      "requester_information": {
        "full_name": "John Smith",
        "address": "131 Acacia Avenue",
        "phone_number": "+13412313",
        "email": "[email protected]"
      },
      "subject_information": {
        "full_name": "John Smith",
        "address": "131 Acacia Avenue",
        "phone_number": "+13412313",
        "email": "[email protected]"
      },
      "information_to_remove": "I wish to remove all indetifiable information about John Smith.",
      "additional_information": "I also would like to have some non identifiable information removed.",
      "request_declaration": {
        "data_holder_name": "some-website.com",
        "signature": "John Smith",
        "date": "2025-01-21"
      },
      "proof_of_address": "https://storage.ocamba.com/7196310/hood/gdpr-request/17368658975598751634/proof_of_address.pdf",
      "proof_of_identity": "https://storage.ocamba.com/7196310/hood/gdpr-request/17368658975598751634/proof_of_identity.pdf",
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}

{
  "code": 400,
  "title": "Bad request.",
  "message": "The request body is not valid.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

{
  "code": 500,
  "title": "Internal server error.",
  "message": "Internal server error."
}