Initiate the consent flow for a student and guardian

curl --request POST \
  --url https://platform.dev.timeback.com/consent/1.0/students/{studentId}/consent-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "guardians": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "correctedFirstName": "<string>",
      "correctedLastName": "<string>"
    }
  ],
  "returnUrl": "<string>",
  "forceResend": false
}
'

import requests

url = "https://platform.dev.timeback.com/consent/1.0/students/{studentId}/consent-requests"

payload = {
    "guardians": [
        {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "correctedFirstName": "<string>",
            "correctedLastName": "<string>"
        }
    ],
    "returnUrl": "<string>",
    "forceResend": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    guardians: [
      {
        id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        correctedFirstName: '<string>',
        correctedLastName: '<string>'
      }
    ],
    returnUrl: '<string>',
    forceResend: false
  })
};

fetch('https://platform.dev.timeback.com/consent/1.0/students/{studentId}/consent-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.dev.timeback.com/consent/1.0/students/{studentId}/consent-requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'guardians' => [
        [
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'correctedFirstName' => '<string>',
                'correctedLastName' => '<string>'
        ]
    ],
    'returnUrl' => '<string>',
    'forceResend' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.dev.timeback.com/consent/1.0/students/{studentId}/consent-requests"

	payload := strings.NewReader("{\n  \"guardians\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"correctedFirstName\": \"<string>\",\n      \"correctedLastName\": \"<string>\"\n    }\n  ],\n  \"returnUrl\": \"<string>\",\n  \"forceResend\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://platform.dev.timeback.com/consent/1.0/students/{studentId}/consent-requests")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"guardians\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"correctedFirstName\": \"<string>\",\n      \"correctedLastName\": \"<string>\"\n    }\n  ],\n  \"returnUrl\": \"<string>\",\n  \"forceResend\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.dev.timeback.com/consent/1.0/students/{studentId}/consent-requests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"guardians\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"correctedFirstName\": \"<string>\",\n      \"correctedLastName\": \"<string>\"\n    }\n  ],\n  \"returnUrl\": \"<string>\",\n  \"forceResend\": false\n}"

response = http.request(request)
puts response.read_body

{
  "imsx_codeMajor": "<string>",
  "imsx_severity": "<string>",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "imsx_codeMajor": "<string>",
  "imsx_severity": "<string>",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {}
}

Consent

Initiate the consent flow for a student and guardian

Machine-to-machine entry point for a partner system to start TimeBack’s email consent flow for an explicit student and guardian: generates the DocuSign envelope and emails the guardian an HMAC-protected signing link. Gated on the consent.write scope and the caller owning the student’s org. Returns 400 if the student’s consent is already granted, or if a named guardian has no active relationship to the student.

POST

consent

1.0

students

{studentId}

consent-requests

Initiate the consent flow for a student and guardian

curl --request POST \
  --url https://platform.dev.timeback.com/consent/1.0/students/{studentId}/consent-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "guardians": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "correctedFirstName": "<string>",
      "correctedLastName": "<string>"
    }
  ],
  "returnUrl": "<string>",
  "forceResend": false
}
'

import requests

url = "https://platform.dev.timeback.com/consent/1.0/students/{studentId}/consent-requests"

payload = {
    "guardians": [
        {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "correctedFirstName": "<string>",
            "correctedLastName": "<string>"
        }
    ],
    "returnUrl": "<string>",
    "forceResend": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    guardians: [
      {
        id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        correctedFirstName: '<string>',
        correctedLastName: '<string>'
      }
    ],
    returnUrl: '<string>',
    forceResend: false
  })
};

fetch('https://platform.dev.timeback.com/consent/1.0/students/{studentId}/consent-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.dev.timeback.com/consent/1.0/students/{studentId}/consent-requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'guardians' => [
        [
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'correctedFirstName' => '<string>',
                'correctedLastName' => '<string>'
        ]
    ],
    'returnUrl' => '<string>',
    'forceResend' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.dev.timeback.com/consent/1.0/students/{studentId}/consent-requests"

	payload := strings.NewReader("{\n  \"guardians\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"correctedFirstName\": \"<string>\",\n      \"correctedLastName\": \"<string>\"\n    }\n  ],\n  \"returnUrl\": \"<string>\",\n  \"forceResend\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://platform.dev.timeback.com/consent/1.0/students/{studentId}/consent-requests")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"guardians\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"correctedFirstName\": \"<string>\",\n      \"correctedLastName\": \"<string>\"\n    }\n  ],\n  \"returnUrl\": \"<string>\",\n  \"forceResend\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.dev.timeback.com/consent/1.0/students/{studentId}/consent-requests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"guardians\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"correctedFirstName\": \"<string>\",\n      \"correctedLastName\": \"<string>\"\n    }\n  ],\n  \"returnUrl\": \"<string>\",\n  \"forceResend\": false\n}"

response = http.request(request)
puts response.read_body

{
  "imsx_codeMajor": "<string>",
  "imsx_severity": "<string>",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "imsx_codeMajor": "<string>",
  "imsx_severity": "<string>",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {}
}

Authorizations

Authorization

string

header

required

OAuth 2.0 client credentials flow. Contact timeback@trilogy.com to request credentials for your application.

Path Parameters

studentId

string<uuid>

required

Unique identifier of the student

Body

application/json

guardians

object[]

required

The parent/guardians to request consent from. Each entry carries the guardian's UUID and may optionally carry a corrected legal name.

Minimum array length: 1

Show child attributes

returnUrl

string<uri>

required

URL the guardian's browser is redirected to after they finish signing in DocuSign. Applies to every guardian in this request. Required: the platform hosts no landing page, so the caller must supply where the guardian lands after signing.

forceResend

boolean

default:false

Explicit signal that a repeat call is an intentional resend. With the default (false), a repeat call for a guardian who was already emailed reuses the envelope and sends no further email, regardless of elapsed time. Set true to re-email; a forced resend is still debounced by a short server-side window, so a double-click or retry cannot double-send. Applies to every guardian in this request.

Response

Consent request accepted

⌘I