REST client
Consents
The 2 operations under consents, as typed calls on the generated REST client.
1 min read
Consents
Available from @codespar/sdk 0.12.0; the version on npm is 0.15.0. Every example on this page is compiled against the installed package when these docs build: a call that does not type-check fails the build.
Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.
import { } from "@codespar/sdk";
const = new ({ : .. });POST /v1/consents
POST
/v1/consentsStart a hosted consent
const = await ..("/v1/consents", {
: {
: "agt_0000000000000000",
: "person@example.com",
: {
: "string",
: 1,
: 1,
: "BRL",
: 0,
: [
"*"
],
: "pix-key",
: [
"string"
],
: [
"string"
],
: [
{
: "BRL",
: "string",
: 1,
: 1
}
],
: "Example",
: "string",
: {}
},
: "https://example.com/hook"
}
});Parameters, body and every documented response: POST /v1/consents in the HTTP reference.
POST /v1/consents/init
POST
/v1/consents/initDeprecated
Start a hosted consent
const = await ..("/v1/consents/init", {
: {
: "agt_0000000000000000",
: "person@example.com",
: {
: "string",
: 1,
: 1,
: "BRL",
: 0,
: [
"*"
],
: "pix-key",
: [
"string"
],
: [
"string"
],
: [
{
: "BRL",
: "string",
: 1,
: 1
}
],
: "Example",
: "string",
: {}
},
: "https://example.com/hook"
}
});Parameters, body and every documented response: POST /v1/consents/init in the HTTP reference.