Contact Verifications
The 2 operations under contact-verifications, as typed calls on the generated REST client.
Contact Verifications
Available from @codespar/sdk 0.12.0; the version on npm is 0.12.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/consumers/{consumerId}/contact-verifications
/v1/consumers/{consumerId}/contact-verificationsSend a one-time code to a consumer's e-mail address or phone number
const = await ..("post", "/v1/consumers/{consumerId}/contact-verifications", {
: {
: "csm_0000000000000000"
},
: {
: "email",
: "string",
: "string"
}
});
// r.status is one of the documented statuses (200, 422),
// each with its own body shape in r.data; nothing here throws on 422.
if (.) {
.(.);
}Parameters, body and every documented response: POST /v1/consumers/{consumerId}/contact-verifications in the HTTP reference.
POST /v1/consumers/{consumerId}/contact-verifications/{id}/verify
/v1/consumers/{consumerId}/contact-verifications/{id}/verifyCheck the code the consumer received
const = await ..("/v1/consumers/{consumerId}/contact-verifications/{id}/verify", {
: {
: "csm_0000000000000000",
: "contactverification_0000000000000000"
},
: {
: "string",
: "string"
}
});Parameters, body and every documented response: POST /v1/consumers/{consumerId}/contact-verifications/{id}/verify in the HTTP reference.