List Workspace compliance Requirements

GET

/workspaces/{workspaceId}/endpoints/{endpointId}/compliance-requirements

List compliance requirements for a capability/destination. If no capability/destination is provided, all compliance requirements are returned. This result may be paginated. To learn more about the pagination, please refer to the pagination section on API Access Common API Usage section.

Antwoord-payload

nextPageToken

string

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display. To know more, refer to the pagination section.

results

array of object

verplicht

Onderliggende attributen tonen

results.status

string

verplicht

Possible values: satisfied, pending, unsatisfied

results.mutable

boolean

verplicht

results.immutableReason

string

Possible values: managed, dependency, none

results.message

string

results.evaluatedAt

string

results.issues

array of string

results.userId

string

results.name

string

verplicht

results.type

string

verplicht

Possible values: kyc-form

results.capabilities

array of string

verplicht

results.destinations

array of string

results.managedBy

string

results.appliesTo

string

Specifies whether this requirement applies to endpoint-level or destination-level evaluation. Empty means both.

Possible values: endpoint, destination

results.forms

array of object

Onderliggende attributen tonen

results.forms.conditions

object

results.forms.countryCode

string

results.forms.createdAt

string

verplicht

results.forms.defaultLocale

string

verplicht

results.forms.gracePeriodDays

integer

results.forms.id

string

verplicht

results.forms.name

string

verplicht

results.forms.questions

array of object

verplicht

Onderliggende attributen tonen

results.forms.questions.locale

string

verplicht

results.forms.questions.questions

array of object

verplicht

Onderliggende attributen tonen

results.forms.questions.questions.conditions

array of object

Onderliggende attributen tonen

results.forms.questions.questions.conditions.key

string

results.forms.questions.questions.conditions.value

string

results.forms.questions.questions.description

string

results.forms.questions.questions.displayName

string

verplicht

results.forms.questions.questions.format

string

verplicht

Possible values: none

results.forms.questions.questions.key

string

verplicht

results.forms.questions.questions.mapping

string

Map the answer to a contact attribute. If not set, the answer will not be mapped.

results.forms.questions.questions.options

array of object

Onderliggende attributen tonen

results.forms.questions.questions.options.key

string

results.forms.questions.questions.options.value

string

results.forms.questions.questions.placeholder

string

results.forms.questions.questions.required

boolean

results.forms.questions.questions.timezone

string

results.forms.questions.questions.type

string

verplicht

Possible values: bool, boolArray, intArray, float, floatArray

results.forms.questions.questions.formQuestionConfig

object

Onderliggende attributen tonen

results.forms.questions.questions.formQuestionConfig.stringDatetimeConfig

object

Onderliggende attributen tonen

results.forms.questions.questions.formQuestionConfig.stringDatetimeConfig.allowTimezoneSelectionByUser

boolean

results.forms.questions.questions.formQuestionConfig.stringDatetimeConfig.datetimeRange

object

verplicht

Onderliggende attributen tonen

results.forms.questions.questions.formQuestionConfig.stringDatetimeConfig.datetimeRange.type

string

Possible values: any, future, past

results.forms.questions.questions.formQuestionConfig.stringDatetimeConfig.defaultTimezone

string

results.forms.questions.questions.formQuestionConfig.stringDatetimeConfig.includeTime

boolean

results.forms.questions.questions.formQuestionConfig.stringDatetimeConfig.localeOverride

string

results.forms.questions.questions.formQuestionConfig.stringDatetimeConfig.timeFormat

string

Possible values: am-pm, 24h

results.forms.questions.questions.formQuestionConfig.stringDatetimeConfig.timePlaceholder

string

results.forms.questions.questions.formQuestionConfig.type

string

Possible values: stringDatetime

results.forms.questions.questions.ui:type

string

hint the UI what form to show if type isn't sufficient

Possible values: shortText, longText, dropdown, radio, checkboxSelect

results.forms.scope

string

verplicht

Possible values: number, organization, channel

results.forms.status

string

verplicht

Possible values: draft, active, deactivated

results.forms.updatedAt

string

verplicht

results.formOptions

object

results.formId

string

results.formEntryId

string

results.formEntry

object

Onderliggende attributen tonen

results.formEntry.answers

array of object

verplicht

Onderliggende attributen tonen

results.formEntry.answers.isDefault

boolean

results.formEntry.answers.key

string

verplicht

results.formEntry.answers.valueString

string

verplicht

results.formEntry.businessProfileId

string

The ID of an existing Business Profile.

results.formEntry.businessProfileVersion

integer

The version of the Business Profile.

results.formEntry.createdAt

string

verplicht

results.formEntry.displayName

string

results.formEntry.formId

string

verplicht

results.formEntry.id

string

verplicht

results.formEntry.locale

string

verplicht

results.formEntry.organizationId

string

verplicht

results.formEntry.reviewComment

string

results.formEntry.status

string

verplicht

The status of the form entry.

Possible values: draft, submitted, approved, rejected, expired

results.formEntry.tags

array of object

Onderliggende attributen tonen

results.formEntry.tags.key

string

verplicht

results.formEntry.tags.value

string

verplicht

results.formEntry.updatedAt

string

verplicht

results.status

string

verplicht

Possible values: satisfied, pending, unsatisfied

results.mutable

boolean

verplicht

results.immutableReason

string

Possible values: managed, dependency, none

results.message

string

results.evaluatedAt

string

results.issues

array of string

results.userId

string

results.name

string

verplicht

results.type

string

verplicht

Possible values: use-case

results.capabilities

array of string

verplicht

results.destinations

array of string

results.managedBy

string

results.appliesTo

string

Specifies whether this requirement applies to endpoint-level or destination-level evaluation. Empty means both.

Possible values: endpoint, destination

results.definition

object

verplicht

Onderliggende attributen tonen

results.definition.fallback

boolean

verplicht

results.definition.id

string

verplicht

results.definition.name

string

verplicht

results.definition.schema

object

verplicht

results.definition.selectors

object

verplicht

Onderliggende attributen tonen

results.definition.selectors.countryCodes

array of string

results.definition.selectors.numberTypes

array of string

results.definition.selectors.platforms

array of string

results.definition.uiSchema

object

verplicht

results.definition.version

string

verplicht

results.useCaseId

string

results.useCase

object

Onderliggende attributen tonen

results.useCase.additionalFields

object

verplicht

results.useCase.caseType

string

verplicht

Possible values: default, tendlc, tfn-verification

results.useCase.createdAt

string

verplicht

results.useCase.definitionDescription

string

verplicht

results.useCase.definitionVersion

string

verplicht

results.useCase.description

string

verplicht

results.useCase.id

string

verplicht

results.useCase.integrationState

object

verplicht

Onderliggende attributen tonen

results.useCase.integrationState.additionalFields

object

verplicht

results.useCase.integrationState.externalId

string

verplicht

results.useCase.integrationState.status

string

verplicht

results.useCase.integrationState.updatedAt

string

verplicht

results.useCase.name

string

verplicht

results.useCase.status

string

verplicht

Possible values: created, cancelled, error, deleted, declined, approved

results.useCase.tags

array of object

Onderliggende attributen tonen

results.useCase.tags.key

string

verplicht

results.useCase.tags.value

string

verplicht

results.useCase.updatedAt

string

verplicht

results.useCase.use

string

verplicht

results.useCase.version

integer

verplicht

results.status

string

verplicht

Possible values: satisfied, pending, unsatisfied

results.mutable

boolean

verplicht

results.immutableReason

string

Possible values: managed, dependency, none

results.message

string

results.evaluatedAt

string

results.issues

array of string

results.userId

string

results.name

string

verplicht

results.type

string

verplicht

Possible values: tfn-verification

results.capabilities

array of string

verplicht

results.destinations

array of string

results.managedBy

string

results.appliesTo

string

Specifies whether this requirement applies to endpoint-level or destination-level evaluation. Empty means both.

Possible values: endpoint, destination

results.tfnVerification

object

Onderliggende attributen tonen

results.tfnVerification.id

string

results.tfnVerification.organizationId

string

results.tfnVerification.workspaceId

string

results.tfnVerification.verificationRequestId

string

results.tfnVerification.longCodeNumberIds

array of string

results.tfnVerification.verificationRequestData

object

Onderliggende attributen tonen

results.tfnVerification.verificationRequestData.phoneNumbers

array of string

results.tfnVerification.verificationRequestData.businessName

string

verplicht

results.tfnVerification.verificationRequestData.businessRegistrationNumber

string

Optional business registration number (TaxID). Used for toll-free verification.

results.tfnVerification.verificationRequestData.businessRegistrationIssuingCountry

string

Country that issued the business registration (ISO 3166-1 alpha-2 code). Any valid country code is accepted.

Possible values: AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW

results.tfnVerification.verificationRequestData.businessRegistrationType

string

Type of business registration:

EIN: Employer Identification Number (US)
CBN: Canada Business Number (CA)
NEQ: Quebec Enterprise Number (CA)
PROVINCIAL_NUMBER: Provincial Business Number (CA)
CRN: Company Registration Number (GB, HK)
VAT: Value-added Tax Identification Number (GB, IE, BR, NL)
ACN: Australian Company Number (AU)
ABN: Australian Business Number (AU)
BRN: Business Registration Number (HK)
SIREN: INSEE identification number (FR)
SIRET: Establishment identification number (FR)
NZBN: New Zealand Business Number (NZ)
UST_IDNR: Umsatzsteuer-Identifikationsnummer (DE)
CIF: Código de Identificación Fiscal (ES)
NIF: Número de Identificación Fiscal (ES)
CNPJ: Cadastro Nacional Da Pessoa Jurídica (BR)
UID: Unternehmens-Identifikationsnummer (CH)
OTHER: Other registration types (covers additional countries including SE)

Possible values: EIN, CBN, NEQ, PROVINCIAL_NUMBER, CRN, VAT, ACN, ABN, BRN, SIREN, SIRET, NZBN, UST_IDNR, CIF, NIF, CNPJ, UID, OTHER

results.tfnVerification.verificationRequestData.entityType

string

Type of business entity. Required if businessRegistrationNumber is provided.

Possible values: SOLE_PROPRIETOR, PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, GOVERNMENT

results.tfnVerification.verificationRequestData.businessAddr1

string

verplicht

results.tfnVerification.verificationRequestData.businessAddr2

string

results.tfnVerification.verificationRequestData.businessZip

string

verplicht

results.tfnVerification.verificationRequestData.businessCity

string

verplicht

results.tfnVerification.verificationRequestData.businessState

string

verplicht

results.tfnVerification.verificationRequestData.businessCountry

string

verplicht

results.tfnVerification.verificationRequestData.businessContactFirstName

string

verplicht

results.tfnVerification.verificationRequestData.businessContactLastName

string

verplicht

results.tfnVerification.verificationRequestData.businessContactEmail

string

verplicht

results.tfnVerification.verificationRequestData.businessContactPhone

string

verplicht

results.tfnVerification.verificationRequestData.corporateWebsite

string

verplicht

results.tfnVerification.verificationRequestData.privacyPolicyUrl

string

URL of the business's privacy policy, as presented to consumers at opt-in.

results.tfnVerification.verificationRequestData.termsAndConditionUrl

string

URL of the business's terms and conditions, as presented to consumers at opt-in.

results.tfnVerification.verificationRequestData.messageVolume

string

verplicht

Possible values: 10, 100, 1000, 10000, 100000, 250000, 500000, 750000, 1000000, 5000000, 10000000+

results.tfnVerification.verificationRequestData.useCase

string

verplicht

results.tfnVerification.verificationRequestData.useCaseSummary

string

verplicht

results.tfnVerification.verificationRequestData.productionMessageContent

string

verplicht

results.tfnVerification.verificationRequestData.optInWorkflowDescription

string

verplicht

results.tfnVerification.verificationRequestData.optInWorkflowImageUrLs

array of string

verplicht

results.tfnVerification.verificationRequestData.additionalInformation

string

results.tfnVerification.verificationRequestData.isvReseller

string

results.tfnVerification.status

string

Possible values: submitted, in-progress, verified, rejected

results.tfnVerification.statusMessage

object

Onderliggende attributen tonen

results.tfnVerification.statusMessage.statusCode

string

results.tfnVerification.statusMessage.declineReasonDescription

string

results.tfnVerification.statusMessage.resubmitAllowed

boolean

results.tfnVerification.testMode

boolean

results.tfnVerification.createdAt

string

results.tfnVerification.updatedAt

string

results.status

string

verplicht

Possible values: satisfied, pending, unsatisfied

results.mutable

boolean

verplicht

results.immutableReason

string

Possible values: managed, dependency, none

results.message

string

results.evaluatedAt

string

results.issues

array of string

results.userId

string

results.name

string

verplicht

results.type

string

verplicht

Possible values: ten-dlc

results.capabilities

array of string

verplicht

results.destinations

array of string

results.managedBy

string

results.appliesTo

string

Specifies whether this requirement applies to endpoint-level or destination-level evaluation. Empty means both.

Possible values: endpoint, destination

results.brandId

string

results.campaignId

string

results.brand

object

Onderliggende attributen tonen

results.brand.id

string

The ID of the number.

results.brand.tcrBrandId

string

The Campaign Registry brand ID.

results.brand.organizationId

string

results.brand.createdAt

string

Timestamp (UTC) when the brand was created.

results.brand.updatedAt

string

Timestamp (UTC) when the brand was last updated.

results.brand.status

string

Brand status

Possible values: FAILED, PENDING, REJECTED, APPROVED, DELETED, DRAFT

results.brand.authPlusStatus

string

Brand Auth+ status

Possible values: NOT_APPLICABLE, NEEDS_CHARGE, NEEDS_TRIGGER, DONE

results.brand.entityType

string

verplicht

Legal entity type. It can't be updated when the brand is approved.

Possible values: PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, GOVERNMENT, ``

results.brand.firstName

string

First or given name. Applicable to entity type.

results.brand.lastName

string

Last or Surname. Applicable to entity type.

results.brand.displayName

string

verplicht

Display or marketing name your brand.

results.brand.companyName

string

verplicht

Legal company name. This should match the legal company name used to register your EIN/Tax ID.

results.brand.ein

string

verplicht

Government assigned corporate tax ID. EIN is 9-digits in the U.S.

results.brand.einIssuingCountry

string

verplicht

The 2 letter ISO country of registration submitted with your EIN / Tax ID registration.

results.brand.phone

string

verplicht

Valid phone number in e.164 international format.

results.brand.street

string

verplicht

Street number and name.

results.brand.city

string

verplicht

City name

results.brand.state

string

verplicht

State. Must be a 2 letter state code for US states.

results.brand.postalCode

string

verplicht

Postal code. Must be a 5 digit zip code for the United States.

results.brand.country

string

verplicht

ISO 2 character country code.

results.brand.email

string

verplicht

Valid email address of brand support contact.

results.brand.stockSymbol

string

Stock symbol.

results.brand.stockExchange

string

Stock exchange. Required for entityType PUBLIC.

Possible values: NONE, NASDAQ, NYSE, AMEX, AMX, ASX, B3, BME, BSE, FRA, ICEX, JPX, JSE, KRX, LON, NSE, OMX, SEHK, SGX, SSE, STO, SWX, SZSE, TSX, TWSE, VSE, OTHER, ``

results.brand.website

string

verplicht

Brand website URL.

results.brand.vertical

string

Vertical or industry segment of the brand.

results.brand.altBusinessId

string

Alternate business identifier.

results.brand.altBusinessIdType

string

Alternate business identifier type. Required if altBusinessId is provided.

Possible values: NONE, DUNS, GIIN, LEI, ``

results.brand.businessContactEmail

string

Business contact email.

results.brand.businessContactEmailVerifiedDate

string

Timestamp (UTC) when the brand businessContactEmail was verified.

results.brand.rejection

object

Rejection details

Onderliggende attributen tonen

results.brand.rejection.description

string

verplicht

Rejection description

results.brand.rejection.code

string

Rejection code

results.campaign

object

Onderliggende attributen tonen

results.campaign.id

string

UUID of the campaign.

results.campaign.name

string

Campaign name

results.campaign.subscription

object

Describes status of Campaign Subscription

Onderliggende attributen tonen

results.campaign.subscription.status

string

Possible values: active, inactive, canceling

results.campaign.subscription.subscribedAt

string

Timestamp (UTC) when the subscription became active.

results.campaign.subscription.updatedAt

string

Timestamp (UTC) when the subscription was last updated.

results.campaign.subscription.cancelledAt

string

Timestamp (UTC) when the subscription was cancelled.

results.campaign.status

string

Campaign status

Possible values: DRAFT, FAILED, PENDING, REJECTED, APPROVED, DECLINED, SUSPENDED, DELETED, EXPIRED

results.campaign.usecase

string

A use case that best matches the purpose of the campaign.

results.campaign.subUsecases

array of string

If use case is MIXED or LOW_VOLUME mixed an array of 2-5 use cases.

results.campaign.description

string

A detailed description of what the campaign is for.

results.campaign.embeddedLink

boolean

Whether messages will contain links. Provide at least one sample containing a link.

results.campaign.embeddedPhone

boolean

Whether messages will contain phone number. Provide at least one sample containing a phone number.

results.campaign.numberPool

boolean

Whether a campaign will be associated with more than 50 numbers e.g. customer service use case.

results.campaign.ageGated

boolean

Whether a campaign contains age-gated content based on carrier/ctia guidelines.

results.campaign.directLending

boolean

Whether a campaign includes content related to direct lending or loan arrangements.

results.campaign.subscriberOptin

boolean

Confirm customer opt in is collected and processed.

results.campaign.subscriberOptout

boolean

Confirm customer opt out is collected and processed.

results.campaign.subscriberHelp

boolean

Confirm an info message is returned if a customer sends "HELP".

results.campaign.samples

array of string

Between 1-5 sample messages, each up to 1024 characters (empty until the campaign is submitted). If directLending, embeddedPhone, embeddedLink is true provide relevant examples.

results.campaign.messageFlow

string

Provide details of how the customer will opt into this campaign. If you have a live web opt-in provide the URL and ensure the page has details on the T&Cs/data collection for opting in, and how to opt out.

results.campaign.helpMessage

string

Help message of the campaign. A help message shall state the name of the service, contact (email or call centre), OPT IN and OPT OUT keywords.

results.campaign.helpKeywords

string

A comma separated list of keywords. Support of the word HELP is the minimum requirement for requesting help/info.

results.campaign.optoutKeywords

string

A comma separated list of keywords. Support of the word STOP is the minimum requirement for OPT OUT.

results.campaign.optinKeywords

string

A comma separated list of keywords. Support of the word START is the minimum requirement for OPT OUT.

results.campaign.optinMessage

string

Provide an example of the message that will be sent after a customer has opted in.

results.campaign.optoutMessage

string

Provide an example of the message that will be sent after a customer has opted out.

results.campaign.termsAndConditions

boolean

Indicates the campaign follows CTIA messaging principles and best practices.

results.campaign.brandId

string

UUID of the brand associated with this campaign. The specified brand MUST be APPROVED.

results.campaign.resellerId

string

UUID of the reseller associated with this campaign. The specified reseller MUST be ACTIVE.

results.campaign.rejection

object

Rejection details

Onderliggende attributen tonen

results.campaign.rejection.description

string

verplicht

Rejection description

results.campaign.rejection.code

string

Rejection code

results.campaign.attachments

array of object

Attachments associated with this campaign.

Onderliggende attributen tonen

results.campaign.attachments.id

string

verplicht

The ID of the attachment.

results.campaign.attachments.status

string

verplicht

Attachment status

Possible values: PENDING, ACTIVE, PENDING_DELETION, DELETED, FAILED, FAILED_DELETION

results.campaign.attachments.createdAt

string

verplicht

Timestamp (UTC) when the attachment was created.

results.campaign.attachments.updatedAt

string

verplicht

Timestamp (UTC) when the attachment was last updated.

results.campaign.attachments.filename

string

verplicht

The original name of the file when it was uploaded.

results.campaign.attachments.mediaUrl

string

The URL to download the attachment.

results.campaign.attachments.contentType

string

verplicht

The detected MIME type of the file.

results.campaign.createdAt

string

Timestamp (UTC) when the campaign was created.

results.campaign.updatedAt

string

Timestamp (UTC) when the campaign was last updated.

results.linkingStatus

string

Possible values: DEFAULT, INACTIVE, PENDING_ACTIVE, ACTIVE, PENDING_INACTIVE, LINK_FAILED, UNLINK_FAILED, ACTIVE_P2P

results.reseller

object

Onderliggende attributen tonen

results.reseller.id

string

UUID of the reseller.

results.reseller.organizationId

string

results.reseller.status

string

Reseller status

Possible values: FAILED, PENDING, ACTIVE, DELETED

results.reseller.companyName

string

verplicht

Legal company name. This should match the legal company name used to register your EIN/Tax ID.

results.reseller.phone

string

verplicht

Valid phone number in e.164 international format.

results.reseller.email

string

verplicht

Valid email address of support contact.

results.reseller.createdAt

string

Timestamp (UTC) when the reseller was created.

results.reseller.updatedAt

string

Timestamp (UTC) when the reseller was last updated.

Codevoorbeeld

curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/endpoints/{endpointId}/compliance-requirements' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'