GET /exams/:exam_id/student_sessions
List the students in an exam

Errors

Code Description
403 You are not authorized to access this page.

Examples

{
  'example_request_params': {
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff',
    'page': 1
  },
  'example_response': {
    'students': [
      {          'id': 1,
        'session_id': null,
        'student_id': null,
        'external_id': null,
        'time_slot': 1,
        'created_at': '2018-11-17T17:01:25.788+01:00',
        'updated_at': '2018-11-17T17:13:30.427+01:00',
        'email': 'student1@example.com',
        'pin_code': 803754,
        'operating_system': 'OS X 10.14.1',
        'browser': 'Chrome',
        'browser_version': '70.0.3538.102',
        'status': 'exam_finished',
        'token': null,
        'screenshare_check': 'not_started',
        'microphone_check': 'not_started',
        'speakers_check': 'not_started',
        'webcam_check': 'not_started',
        'mobile_check': 'not_started',
        'dummy_exam_survey': null,
        'skip_requirements': false,
        'send_confirmation': false,
        'name': 'Student 1',
        'start_time': '2018-11-17T17:09:39.373+01:00',
        'exam_id': 1,
        'expires_at': null,
        'end_time': '2018-11-17T17:10:19.477+01:00',
        'entered_room': true,
        'reservation_time': '2018-11-17T17:04:28.633+01:00',
        'exam_document_content_type': null,
        'exam_document_file_size': null,
        'exam_document_updated_at': null,
        'reviewed': '10',
        'id_card_file_name': 'data',
        'id_card_content_type': 'image/png',
        'id_card_file_size': 187297,
        'face_photo_file_name': 'data',
        'face_photo_content_type': 'image/png',
        'face_photo_file_size': 206025,
        'bandwidth_check': 'not_started',
        'bandwidth_speed': null,
        'open_time': '2018-11-13T11:13:00.000+01:00',
        'individual_info': 'individual_info for user 1',
        'rtc_session_id': 0,
        'in_setup': false,
        'in_check_requirements': false,
        'attempt': 0,
        'archived': true,
        'current_exam_mode': '01010000',
        'rtc_session_ids': [],
        'transcoding_status': 'not_sent_to_queue',
        'is_individual_info_html': true,
        'priority': '01',
        'recording_started_at': null,
        'recording_ended_at': null,
        'is_email_sent': false,
        'incidents': [{'id': 1,
          'student_session_id': 1,
          'comment': 'comment',
          'created_at': '2018-11-17T17:10:19.477+01:00',
          'updated_at': '2018-11-17T17:10:19.477+01:00',
          'offset_time':0}
        ]
      }
    ]
  }
}

Params

Param name Description
exam_id
required

ID of the student's exam.

Validations:

  • Must be a number.

status
optional

Status to filter student sessions. Has to be one of registered,before_check_req_mail,email_bounced,email_sent,after_check_req_mail,before_check_req,after_check_req,in_setup,exam_not_started,exam_started,exam_finished

Validations:

  • Must be a String

page
optional

Page number, returns LIMIT items per page. The X-Pagination-* HTTP headers contain the information about the total number of items (X-Pagination-Item-Count), the total number of pages (X-Pagination-Page-Count), the current page number (X-Pagination-Page) and the number of items per page (X-Pagination-Limit).

Validations:

  • Must be a number.

limit
optional

Number of items returned per page. Default and maximum value is 300.

Validations:

  • Must be a number.

timestamp
required

Timestamp of the request in milliseconds.

Validations:

  • Must be a number.

nonce
required

Random number unique between the api calls made in the previous 24 hours.

Validations:

  • Must be a number.

signature
required

HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format 'name=value' joined by '?' and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string

Validations:

  • Must be a String


GET /student_sessions
List all student_sessions

Errors

Code Description
403 You are not authorized to access this page.

Examples

{
  'example_request_params': {
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff',
    'page': 1
  },
  'example_response': {
    'students': [
      {
        'id': 1,
        'session_id': null,
        'student_id': null,
        'external_id': null,
        'time_slot': 1,
        'created_at': '2018-11-17T17:01:25.788+01:00',
        'updated_at': '2018-11-17T17:13:30.427+01:00',
        'email': 'student1@example.com',
        'pin_code': 803754,
        'operating_system': 'OS X 10.14.1',
        'browser': 'Chrome',
        'browser_version': '70.0.3538.102',
        'status': 'exam_finished',
        'token': null,
        'screenshare_check': 'not_started',
        'microphone_check': 'not_started',
        'speakers_check': 'not_started',
        'webcam_check': 'not_started',
        'mobile_check': 'not_started',
        'dummy_exam_survey': null,
        'skip_requirements': false,
        'send_confirmation': false,
        'name': 'Student 1',
        'start_time': '2018-11-17T17:09:39.373+01:00',
        'exam_id': 1,
        'expires_at': null,
        'end_time': '2018-11-17T17:10:19.477+01:00',
        'entered_room': true,
        'reservation_time': '2018-11-17T17:04:28.633+01:00',
        'exam_document_content_type': null,
        'exam_document_file_size': null,
        'exam_document_updated_at': null,
        'reviewed': '10',
        'id_card_file_name': 'data',
        'id_card_content_type': 'image/png',
        'id_card_file_size': 187297,
        'face_photo_file_name': 'data',
        'face_photo_content_type': 'image/png',
        'face_photo_file_size': 206025,
        'bandwidth_check': 'not_started',
        'bandwidth_speed': null,
        'open_time': '2018-11-13T11:13:00.000+01:00',
        'individual_info': 'individual_info for user 1',
        'rtc_session_id': 0,
        'in_setup': false,
        'in_check_requirements': false,
        'attempt': 0,
        'archived': true,
        'current_exam_mode': '01010000',
        'rtc_session_ids': [],
        'transcoding_status': 'not_sent_to_queue',
        'is_individual_info_html': true,
        'priority': '01',
        'recording_started_at': null,
        'recording_ended_at': null,
        'is_email_sent': false,
        'incidents': [{'id': 1,
          'student_session_id': 1,
          'comment': 'comment',
          'created_at': '2018-11-17T17:10:19.477+01:00',
          'updated_at': '2018-11-17T17:10:19.477+01:00',
          'offset_time':0}
        ]
      }
    ]
  }
}

Params

Param name Description
status
optional

Status to filter student sessions. Has to be one of registered,before_check_req_mail,email_bounced,email_sent,after_check_req_mail,before_check_req,after_check_req,in_setup,exam_not_started,exam_started,exam_finished

Validations:

  • Must be a String

page
optional

Page number, returns LIMIT items per page. The X-Pagination-* HTTP headers contain the information about the total number of items (X-Pagination-Item-Count), the total number of pages (X-Pagination-Page-Count), the current page number (X-Pagination-Page) and the number of items per page (X-Pagination-Limit).

Validations:

  • Must be a number.

limit
optional

Number of items returned per page. Default and maximum value is 300.

Validations:

  • Must be a number.

timestamp
required

Timestamp of the request in milliseconds.

Validations:

  • Must be a number.

nonce
required

Random number unique between the api calls made in the previous 24 hours.

Validations:

  • Must be a number.

signature
required

HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format 'name=value' joined by '?' and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string

Validations:

  • Must be a String


GET /student_sessions/:id
Show a student by its id

Errors

Code Description
404 Couldn't find Student Session with 'id'=':student_session_id'
403 You are not authorized to access this page.

Examples

{
  'example_request_params': {
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {
    'student': {
      'id': 1,
      'session_id': null,index
      'student_id': null,
      'external_id': null,
      'time_slot': 1,
      'created_at': '2018-11-17T17:01:25.788+01:00',
      'updated_at': '2018-11-17T17:13:30.427+01:00',
      'email': 'student1@example.com',
      'pin_code': 803754,
      'operating_system': 'OS X 10.14.1',
      'browser': 'Chrome',
      'browser_version': '70.0.3538.102',
      'status': 'exam_finished',
      'token': null,
      'screenshare_check': 'not_started',
      'microphone_check': 'not_started',
      'speakers_check': 'not_started',
      'webcam_check': 'not_started',
      'mobile_check': 'not_started',
      'dummy_exam_survey': null,
      'skip_requirements': false,
      'send_confirmation': false,
      'name': 'Student 1',
      'start_time': '2018-11-17T17:09:39.373+01:00',
      'exam_id': 1,
      'expires_at': null,
      'end_time': '2018-11-17T17:10:19.477+01:00',
      'entered_room': true,
      'reservation_time': '2018-11-17T17:04:28.633+01:00',
      'exam_document_content_type': null,
      'exam_document_file_size': null,
      'exam_document_updated_at': null,
      'reviewed': '10',
      'id_card_file_name': 'data',
      'id_card_content_type': 'image/png',
      'id_card_file_size': 187297,
      'face_photo_file_name': 'data',
      'face_photo_content_type': 'image/png',
      'face_photo_file_size': 206025,
      'bandwidth_check': 'not_started',
      'bandwidth_speed': null,
      'open_time': '2018-11-13T11:13:00.000+01:00',
      'individual_info': 'individual_info for user 1',
      'rtc_session_id': 0,
      'in_setup': false,
      'in_check_requirements': false,
      'attempt': 0,
      'archived': true,
      'current_exam_mode': '01010000',
      'rtc_session_ids': [],
      'transcoding_status': 'not_sent_to_queue',
      'is_individual_info_html': true,
      'priority': '01',
      'recording_started_at': null,
      'recording_ended_at': null,
      'is_email_sent': false,
      'incidents': [{'id': 1,
        'student_session_id': 1,
        'comment': 'comment',
        'created_at': '2018-11-17T17:10:19.477+01:00',
        'updated_at': '2018-11-17T17:10:19.477+01:00',
        'offset_time':0}
      ]
    }
  }
}

Params

Param name Description
id
required

ID of the student_session.

Validations:

  • Must be a number.

timestamp
required

Timestamp of the request in milliseconds.

Validations:

  • Must be a number.

nonce
required

Random number unique between the api calls made in the previous 24 hours.

Validations:

  • Must be a number.

signature
required

HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format 'name=value' joined by '?' and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string

Validations:

  • Must be a String


POST /exams/:exam_id/student_sessions
Create and add a student to an exam

Errors

Code Description
403 You are not authorized to access this page.
422 Param is missing or the value is empty: 'param'
422 'email':['has already been taken']

Examples

{
  'example_request_params': {
    'name':'Student 1',
    'email':'student1@example.com',
    'individual_info':'individual_info for user 1',
    'is_individual_info_html': true,
    'skip_requirements': true,
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {
    'student': {
      'id': 1,
      'session_id': null,
      'student_id': null,
      'external_id': null,
      'time_slot': 1,
      'created_at': '2018-11-17T17:01:25.788+01:00',
      'updated_at': '2018-11-17T17:13:30.427+01:00',
      'email': 'student1@example.com',
      'pin_code': 803754,
      'operating_system': 'OS X 10.14.1',
      'browser': 'Chrome',
      'browser_version': '70.0.3538.102',
      'status': 'exam_finished',
      'token': null,
      'screenshare_check': 'not_started',
      'microphone_check': 'not_started',
      'speakers_check': 'not_started',
      'webcam_check': 'not_started',
      'mobile_check': 'not_started',
      'dummy_exam_survey': null,
      'skip_requirements': true,
      'send_confirmation': false,
      'name': 'Student 1',
      'start_time': '2018-11-17T17:09:39.373+01:00',
      'exam_id': 1,
      'expires_at': null,
      'end_time': '2018-11-17T17:10:19.477+01:00',
      'entered_room': true,
      'reservation_time': '2018-11-17T17:04:28.633+01:00',
      'exam_document_content_type': null,
      'exam_document_file_size': null,
      'exam_document_updated_at': null,
      'reviewed': '10',
      'id_card_file_name': 'data',
      'id_card_content_type': 'image/png',
      'id_card_file_size': 187297,
      'face_photo_file_name': 'data',
      'face_photo_content_type': 'image/png',
      'face_photo_file_size': 206025,
      'bandwidth_check': 'not_started',
      'bandwidth_speed': null,
      'open_time': '2018-11-13T11:13:00.000+01:00',
      'individual_info': 'individual_info for user 1',
      'rtc_session_id': 0,
      'in_setup': false,
      'in_check_requirements': false,
      'attempt': 0,
      'archived': true,
      'current_exam_mode': '01010000',
      'rtc_session_ids': [],
      'transcoding_status': 'not_sent_to_queue',
      'is_individual_info_html': true,
      'priority': '01',
      'recording_started_at': null,
      'recording_ended_at': null
    }
  }
}

Params

Param name Description
exam_id
required

ID of the student's exam.

Validations:

  • Must be a number.

name
required

Name of the student.

Validations:

  • Must be a String

email
required

Email of the student.

Validations:

  • Must be a String

external_id
optional

External id of the student.

Validations:

  • Must be a String

individual_info
optional

Individual information for the student.

Validations:

  • Must be a String

is_individual_info_html
optional

Individual information display mode: html or plain text

Validations:

  • Must be one of: true, false, 1, 0.

skip_requirements
optional

The student does not have to go through the requirements check before getting the exam session email

Validations:

  • Must be one of: true, false, 1, 0.

open_time
optional

The earliest time in EPOCH format that a student is allowed to begin their exam.

Validations:

  • Must be a number.

timestamp
required

Timestamp of the request in milliseconds.

Validations:

  • Must be a number.

nonce
required

Random number unique between the api calls made in the previous 24 hours.

Validations:

  • Must be a number.

signature
required

HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format 'name=value' joined by '?' and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string

Validations:

  • Must be a String


PATCH /student_sessions/:id
Update a student

PUT /student_sessions/:id
Update a student

Errors

Code Description
403 You are not authorized to access this page.
422 'email':['has already been taken']

Examples

{
  'example_request_params': {
    'name':'Student 1',
    'email':'student1@example.com',
    'individual_info':'individual_info for user 1',
    'is_individual_info_html': true,
    'skip_requirements': true,
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {
    'student': {
      'id': 1,
      'session_id': null,
      'student_id': null,
      'external_id': null,
      'time_slot': 1,
      'created_at': '2018-11-17T17:01:25.788+01:00',
      'updated_at': '2018-11-17T17:13:30.427+01:00',
      'email': 'student1@example.com',
      'pin_code': 803754,
      'operating_system': 'OS X 10.14.1',
      'browser': 'Chrome',
      'browser_version': '70.0.3538.102',
      'status': 'exam_finished',
      'token': null,
      'screenshare_check': 'not_started',
      'microphone_check': 'not_started',
      'speakers_check': 'not_started',
      'webcam_check': 'not_started',
      'mobile_check': 'not_started',
      'dummy_exam_survey': null,
      'skip_requirements': true,
      'send_confirmation': false,
      'name': 'Student 1',
      'start_time': '2018-11-17T17:09:39.373+01:00',
      'exam_id': 1,
      'expires_at': null,
      'end_time': '2018-11-17T17:10:19.477+01:00',
      'entered_room': true,
      'reservation_time': '2018-11-17T17:04:28.633+01:00',
      'exam_document_content_type': null,
      'exam_document_file_size': null,
      'exam_document_updated_at': null,
      'reviewed': '10',
      'id_card_file_name': 'data',
      'id_card_content_type': 'image/png',
      'id_card_file_size': 187297,
      'face_photo_file_name': 'data',
      'face_photo_content_type': 'image/png',
      'face_photo_file_size': 206025,
      'bandwidth_check': 'not_started',
      'bandwidth_speed': null,
      'open_time': '2018-11-13T11:13:00.000+01:00',
      'individual_info': 'individual_info for user 1',
      'rtc_session_id': 0,
      'in_setup': false,
      'in_check_requirements': false,
      'attempt': 0,
      'archived': true,
      'current_exam_mode': '01010000',
      'rtc_session_ids': [],
      'transcoding_status': 'not_sent_to_queue',
      'is_individual_info_html': true,
      'priority': '01',
      'recording_started_at': null,
      'recording_ended_at': null
    }
  }
}

Params

Param name Description
name
optional

Name of the student.

Validations:

  • Must be a String

email
optional

Email of the student.

Validations:

  • Must be a String

external_id
optional

External id of the student.

Validations:

  • Must be a String

individual_info
optional

Individual information for the student.

Validations:

  • Must be a String

is_individual_info_html
optional

Individual information display mode: html or plain text

Validations:

  • Must be one of: true, false, 1, 0.

skip_requirements
optional

The student does not have to go through the requirements check before getting the exam session email

Validations:

  • Must be one of: true, false, 1, 0.

open_time
optional

The earliest time in EPOCH format that a student is allowed to begin their exam.

Validations:

  • Must be a number.

timestamp
required

Timestamp of the request in milliseconds.

Validations:

  • Must be a number.

nonce
required

Random number unique between the api calls made in the previous 24 hours.

Validations:

  • Must be a number.

signature
required

HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format 'name=value' joined by '?' and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string

Validations:

  • Must be a String


DELETE /student_sessions/:id
Destroy and remove a student from an exam

Errors

Code Description
404 Couldn't find Student Session with 'id'=':student_session_id'
403 You are not authorized to access this page.

Examples

{
  'example_request_params': {
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {}
}

Params

Param name Description
id
required

ID of the student_session.

Validations:

  • Must be a number.

timestamp
required

Timestamp of the request in milliseconds.

Validations:

  • Must be a number.

nonce
required

Random number unique between the api calls made in the previous 24 hours.

Validations:

  • Must be a number.

signature
required

HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format 'name=value' joined by '?' and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string

Validations:

  • Must be a String


POST /student_sessions/:id/end_exam
Ends a student session, stops the recordings and sends a notification to the student

Errors

Code Description
404 Couldn't find Student Session with 'id'=':student_session_id'
403 You are not authorized to access this page.

Examples

{
  'example_request_params': {
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff',
    'notification_title': 'Exam ended',
    'notification_text': 'The exam ended by api',
    'notification_type': 'warning'
  },
  'example_response': {
    'message': 'end_exam_time_success',
    'end_time': '2018-11-17T17:10:19.477+01:00',
    'recording_response': true
  }
}

Params

Param name Description
id
required

ID of the student_session.

Validations:

  • Must be a number.

notification_title
required

Validations:

  • Must be a String

notification_text
required

Validations:

  • Must be a String

notification_type
required

Validations:

  • Must be one of: warning, error, success, info.

timestamp
required

Timestamp of the request in milliseconds.

Validations:

  • Must be a number.

nonce
required

Random number unique between the api calls made in the previous 24 hours.

Validations:

  • Must be a number.

signature
required

HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format 'name=value' joined by '?' and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string

Validations:

  • Must be a String


DELETE /student_sessions/:id/id_card
Destroy the ID photo of a student

Errors

Code Description
404 Couldn't find the ID Photo for the student.
403 You are not authorized to access this page.

Examples

{
  'example_request_params': {
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {}
}

Params

Param name Description
id
required

ID of the student_session.

Validations:

  • Must be a number.

timestamp
required

Timestamp of the request in milliseconds.

Validations:

  • Must be a number.

nonce
required

Random number unique between the api calls made in the previous 24 hours.

Validations:

  • Must be a number.

signature
required

HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format 'name=value' joined by '?' and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string

Validations:

  • Must be a String


DELETE /student_sessions/:id/face_photo
Destroy the face photo of a student

Errors

Code Description
404 Couldn't find the face photo for the student.
403 You are not authorized to access this page.

Examples

{
  'example_request_params': {
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {}
}

Params

Param name Description
id
required

ID of the student_session.

Validations:

  • Must be a number.

timestamp
required

Timestamp of the request in milliseconds.

Validations:

  • Must be a number.

nonce
required

Random number unique between the api calls made in the previous 24 hours.

Validations:

  • Must be a number.

signature
required

HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format 'name=value' joined by '?' and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string

Validations:

  • Must be a String


GET /student_sessions/:id/face_photo
Get a expiring url, lasting for 5 minutes, for the face_photo of the student

Errors

Code Description
404 Couldn't find the Face Photo for the student.
403 You are not authorized to access this page.

Examples

{
  'example_request_params': {
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
  },
  'example_response': {
    'face_photo': 'face_photo_expiring_url'
  }
}

Params

Param name Description
timestamp
required

Timestamp of the request in milliseconds.

Validations:

  • Must be a number.

nonce
required

Random number unique between the api calls made in the previous 24 hours.

Validations:

  • Must be a number.

signature
required

HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format 'name=value' joined by '?' and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string

Validations:

  • Must be a String


POST /student_sessions/:id/assign_proctor
Assigns proctor to a student session

Errors

Code Description
404 Couldn't find Student Session with 'id'=':student_session_id'.
403 You are not authorized to access this page.
422 Invalid parameters. When one of the parameters is invalid for the assignment.
404 Not found error. When one of the resources not found for the assignment.

Examples

{
  'example_request_params': {
    'nonce': '1527500365',
    'timestamp': 1527500365052,
    'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff',
    'proctor_id': '1'
  },
  'example_response': {
    'student_session_id': 2,
    'proctor_id': 1
  }
}

Params

Param name Description
id
required

ID of the student_session.

Validations:

  • Must be a number.

proctor_id
required

ID of the proctor.

Validations:

  • Must be a number.

timestamp
required

Timestamp of the request in milliseconds.

Validations:

  • Must be a number.

nonce
required

Random number unique between the api calls made in the previous 24 hours.

Validations:

  • Must be a number.

signature
required

HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format 'name=value' joined by '?' and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string

Validations:

  • Must be a String