node-sdk/models/verification-request.ts at b913283f27ee7dc505b6d96f7710c4b45247008a · Bandwidth/node-sdk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/* tslint:disable */
/* eslint-disable */
/**
 * Bandwidth
 * Bandwidth\'s Communication APIs
 *
 * The version of the OpenAPI document: 1.0.0
 * Contact: letstalk@bandwidth.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


// May contain unused imports in some cases
// @ts-ignore
import type { Address } from './address';
// May contain unused imports in some cases
// @ts-ignore
import type { BusinessEntityTypeEnum } from './business-entity-type-enum';
// May contain unused imports in some cases
// @ts-ignore
import type { BusinessRegistrationTypeEnum } from './business-registration-type-enum';
// May contain unused imports in some cases
// @ts-ignore
import type { Contact } from './contact';
// May contain unused imports in some cases
// @ts-ignore
import type { OptInWorkflow } from './opt-in-workflow';

export interface VerificationRequest {
    'businessAddress': Address;
    'businessContact': Contact;
    /**
     * Estimated monthly volume of messages from the toll-free number.
     */
    'messageVolume': number;
    'phoneNumbers': Array<string>;
    /**
     * The category of the use case.
     */
    'useCase': string;
    /**
     * A general idea of the use case and customer.
     */
    'useCaseSummary': string;
    /**
     * Example of message content.
     */
    'productionMessageContent': string;
    'optInWorkflow': OptInWorkflow;
    /**
     * Any additional information.
     */
    'additionalInformation'?: string | null;
    /**
     * ISV name.
     */
    'isvReseller'?: string | null;
    /**
     * The Toll-Free Verification request privacy policy URL.
     */
    'privacyPolicyUrl'?: string;
    /**
     * The Toll-Free Verification request terms and conditions policy URL.
     */
    'termsAndConditionsUrl'?: string;
    /**
     * The company \'Doing Business As\'.
     */
    'businessDba'?: string;
    /**
     * US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025.
     */
    'businessRegistrationNumber'?: string | null;
    'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
    'businessEntityType'?: BusinessEntityTypeEnum | null;
    /**
     * A message that gets sent to users requesting help.
     */
    'helpMessageResponse'?: string | null;
    /**
     * Indicates whether the content is age-gated.
     */
    'ageGatedContent'?: boolean;
    /**
     * The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. If you pass an empty string, it will be passed along and potentially rejected.
     */
    'cvToken'?: string | null;
}