Get Workspace Compliance Requirements

GET

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

Get a specific compliance requirement for an endpoint. An example of requirement name is use-case-sms, kyc-form, brand (general brand identification) and brand:nl (specific, country-level brand identification requirement).

Antwort-Payload

status

string

erforderlich

Possible values: satisfied, pending, unsatisfied

mutable

boolean

erforderlich

immutableReason

string

Possible values: managed, dependency, none

message

string

evaluatedAt

string

issues

array of string

userId

string

name

string

erforderlich

type

string

erforderlich

Possible values: kyc-form

capabilities

array of string

erforderlich

destinations

array of string

managedBy

string

appliesTo

string

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

Possible values: endpoint, destination

forms

array of object

Untergeordnete Attribute anzeigen

forms.conditions

object

forms.countryCode

string

forms.createdAt

string

erforderlich

forms.defaultLocale

string

erforderlich

forms.gracePeriodDays

integer

forms.id

string

erforderlich

forms.name

string

erforderlich

forms.questions

array of object

erforderlich

Untergeordnete Attribute anzeigen

forms.questions.locale

string

erforderlich

forms.questions.questions

array of object

erforderlich

Untergeordnete Attribute anzeigen

forms.questions.questions.conditions

array of object

Untergeordnete Attribute anzeigen

forms.questions.questions.conditions.key

string

forms.questions.questions.conditions.value

string

forms.questions.questions.description

string

forms.questions.questions.displayName

string

erforderlich

forms.questions.questions.format

string

erforderlich

Possible values: none

forms.questions.questions.key

string

erforderlich

forms.questions.questions.mapping

string

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

forms.questions.questions.options

array of object

Untergeordnete Attribute anzeigen

forms.questions.questions.options.key

string

forms.questions.questions.options.value

string

forms.questions.questions.placeholder

string

forms.questions.questions.required

boolean

forms.questions.questions.timezone

string

forms.questions.questions.type

string

erforderlich

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

forms.questions.questions.formQuestionConfig

object

Untergeordnete Attribute anzeigen

forms.questions.questions.formQuestionConfig.stringDatetimeConfig

object

Untergeordnete Attribute anzeigen

forms.questions.questions.formQuestionConfig.stringDatetimeConfig.allowTimezoneSelectionByUser

boolean

forms.questions.questions.formQuestionConfig.stringDatetimeConfig.datetimeRange

object

erforderlich

Untergeordnete Attribute anzeigen

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

string

Possible values: any, future, past

forms.questions.questions.formQuestionConfig.stringDatetimeConfig.defaultTimezone

string

forms.questions.questions.formQuestionConfig.stringDatetimeConfig.includeTime

boolean

forms.questions.questions.formQuestionConfig.stringDatetimeConfig.localeOverride

string

forms.questions.questions.formQuestionConfig.stringDatetimeConfig.timeFormat

string

Possible values: am-pm, 24h

forms.questions.questions.formQuestionConfig.stringDatetimeConfig.timePlaceholder

string

forms.questions.questions.formQuestionConfig.type

string

Possible values: stringDatetime

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

forms.scope

string

erforderlich

Possible values: number, organization, channel

forms.status

string

erforderlich

Possible values: draft, active, deactivated

forms.updatedAt

string

erforderlich

formOptions

object

formId

string

formEntryId

string

formEntry

object

Untergeordnete Attribute anzeigen

formEntry.answers

array of object

erforderlich

Untergeordnete Attribute anzeigen

formEntry.answers.isDefault

boolean

formEntry.answers.key

string

erforderlich

formEntry.answers.valueString

string

erforderlich

formEntry.businessProfileId

string

The ID of an existing Business Profile.

formEntry.businessProfileVersion

integer

The version of the Business Profile.

formEntry.createdAt

string

erforderlich

formEntry.displayName

string

formEntry.formId

string

erforderlich

formEntry.id

string

erforderlich

formEntry.locale

string

erforderlich

formEntry.organizationId

string

erforderlich

formEntry.reviewComment

string

formEntry.status

string

erforderlich

The status of the form entry.

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

formEntry.tags

array of object

Untergeordnete Attribute anzeigen

formEntry.tags.key

string

erforderlich

formEntry.tags.value

string

erforderlich

formEntry.updatedAt

string

erforderlich

status

string

erforderlich

Possible values: satisfied, pending, unsatisfied

mutable

boolean

erforderlich

immutableReason

string

Possible values: managed, dependency, none

message

string

evaluatedAt

string

issues

array of string

userId

string

name

string

erforderlich

type

string

erforderlich

Possible values: use-case

capabilities

array of string

erforderlich

destinations

array of string

managedBy

string

appliesTo

string

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

Possible values: endpoint, destination

definition

object

erforderlich

Untergeordnete Attribute anzeigen

definition.fallback

boolean

erforderlich

definition.id

string

erforderlich

definition.name

string

erforderlich

definition.schema

object

erforderlich

definition.selectors

object

erforderlich

Untergeordnete Attribute anzeigen

definition.selectors.countryCodes

array of string

definition.selectors.numberTypes

array of string

definition.selectors.platforms

array of string

definition.uiSchema

object

erforderlich

definition.version

string

erforderlich

useCaseId

string

useCase

object

Untergeordnete Attribute anzeigen

useCase.additionalFields

object

erforderlich

useCase.caseType

string

erforderlich

Possible values: default, tendlc, tfn-verification

useCase.createdAt

string

erforderlich

useCase.definitionDescription

string

erforderlich

useCase.definitionVersion

string

erforderlich

useCase.description

string

erforderlich

useCase.id

string

erforderlich

useCase.integrationState

object

erforderlich

Untergeordnete Attribute anzeigen

useCase.integrationState.additionalFields

object

erforderlich

useCase.integrationState.externalId

string

erforderlich

useCase.integrationState.status

string

erforderlich

useCase.integrationState.updatedAt

string

erforderlich

useCase.name

string

erforderlich

useCase.status

string

erforderlich

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

useCase.tags

array of object

Untergeordnete Attribute anzeigen

useCase.tags.key

string

erforderlich

useCase.tags.value

string

erforderlich

useCase.updatedAt

string

erforderlich

useCase.use

string

erforderlich

useCase.version

integer

erforderlich

status

string

erforderlich

Possible values: satisfied, pending, unsatisfied

mutable

boolean

erforderlich

immutableReason

string

Possible values: managed, dependency, none

message

string

evaluatedAt

string

issues

array of string

userId

string

name

string

erforderlich

type

string

erforderlich

Possible values: tfn-verification

capabilities

array of string

erforderlich

destinations

array of string

managedBy

string

appliesTo

string

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

Possible values: endpoint, destination

tfnVerification

object

Untergeordnete Attribute anzeigen

tfnVerification.id

string

tfnVerification.organizationId

string

tfnVerification.workspaceId

string

tfnVerification.verificationRequestId

string

tfnVerification.longCodeNumberIds

array of string

tfnVerification.verificationRequestData

object

Untergeordnete Attribute anzeigen

tfnVerification.verificationRequestData.phoneNumbers

array of string

tfnVerification.verificationRequestData.businessName

string

erforderlich

tfnVerification.verificationRequestData.businessRegistrationNumber

string

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

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

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

tfnVerification.verificationRequestData.entityType

string

Type of business entity. Required if businessRegistrationNumber is provided.

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

tfnVerification.verificationRequestData.businessAddr1

string

erforderlich

tfnVerification.verificationRequestData.businessAddr2

string

tfnVerification.verificationRequestData.businessZip

string

erforderlich

tfnVerification.verificationRequestData.businessCity

string

erforderlich

tfnVerification.verificationRequestData.businessState

string

erforderlich

tfnVerification.verificationRequestData.businessCountry

string

erforderlich

tfnVerification.verificationRequestData.businessContactFirstName

string

erforderlich

tfnVerification.verificationRequestData.businessContactLastName

string

erforderlich

tfnVerification.verificationRequestData.businessContactEmail

string

erforderlich

tfnVerification.verificationRequestData.businessContactPhone

string

erforderlich

tfnVerification.verificationRequestData.corporateWebsite

string

erforderlich

tfnVerification.verificationRequestData.privacyPolicyUrl

string

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

tfnVerification.verificationRequestData.termsAndConditionUrl

string

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

tfnVerification.verificationRequestData.messageVolume

string

erforderlich

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

tfnVerification.verificationRequestData.useCase

string

erforderlich

tfnVerification.verificationRequestData.useCaseSummary

string

erforderlich

tfnVerification.verificationRequestData.productionMessageContent

string

erforderlich

tfnVerification.verificationRequestData.optInWorkflowDescription

string

erforderlich

tfnVerification.verificationRequestData.optInWorkflowImageUrLs

array of string

erforderlich

tfnVerification.verificationRequestData.additionalInformation

string

tfnVerification.verificationRequestData.isvReseller

string

tfnVerification.status

string

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

tfnVerification.statusMessage

object

Untergeordnete Attribute anzeigen

tfnVerification.statusMessage.statusCode

string

tfnVerification.statusMessage.declineReasonDescription

string

tfnVerification.statusMessage.resubmitAllowed

boolean

tfnVerification.testMode

boolean

tfnVerification.createdAt

string

tfnVerification.updatedAt

string

status

string

erforderlich

Possible values: satisfied, pending, unsatisfied

mutable

boolean

erforderlich

immutableReason

string

Possible values: managed, dependency, none

message

string

evaluatedAt

string

issues

array of string

userId

string

name

string

erforderlich

type

string

erforderlich

Possible values: ten-dlc

capabilities

array of string

erforderlich

destinations

array of string

managedBy

string

appliesTo

string

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

Possible values: endpoint, destination

brandId

string

campaignId

string

brand

object

Untergeordnete Attribute anzeigen

brand.id

string

The ID of the number.

brand.tcrBrandId

string

The Campaign Registry brand ID.

brand.organizationId

string

brand.createdAt

string

Timestamp (UTC) when the brand was created.

brand.updatedAt

string

Timestamp (UTC) when the brand was last updated.

brand.status

string

Brand status

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

brand.authPlusStatus

string

Brand Auth+ status

Possible values: NOT_APPLICABLE, NEEDS_CHARGE, NEEDS_TRIGGER, DONE

brand.entityType

string

erforderlich

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

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

brand.firstName

string

First or given name. Applicable to entity type.

brand.lastName

string

Last or Surname. Applicable to entity type.

brand.displayName

string

erforderlich

Display or marketing name your brand.

brand.companyName

string

erforderlich

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

brand.ein

string

erforderlich

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

brand.einIssuingCountry

string

erforderlich

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

brand.phone

string

erforderlich

Valid phone number in e.164 international format.

brand.street

string

erforderlich

Street number and name.

brand.city

string

erforderlich

City name

brand.state

string

erforderlich

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

brand.postalCode

string

erforderlich

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

brand.country

string

erforderlich

ISO 2 character country code.

brand.email

string

erforderlich

Valid email address of brand support contact.

brand.stockSymbol

string

Stock symbol.

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, ``

brand.website

string

erforderlich

Brand website URL.

brand.vertical

string

Vertical or industry segment of the brand.

brand.altBusinessId

string

Alternate business identifier.

brand.altBusinessIdType

string

Alternate business identifier type. Required if altBusinessId is provided.

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

brand.businessContactEmail

string

Business contact email.

brand.businessContactEmailVerifiedDate

string

Timestamp (UTC) when the brand businessContactEmail was verified.

brand.rejection

object

Rejection details

Untergeordnete Attribute anzeigen

brand.rejection.description

string

erforderlich

Rejection description

brand.rejection.code

string

Rejection code

campaign

object

Untergeordnete Attribute anzeigen

campaign.id

string

UUID of the campaign.

campaign.name

string

Campaign name

campaign.subscription

object

Describes status of Campaign Subscription

Untergeordnete Attribute anzeigen

campaign.subscription.status

string

Possible values: active, inactive, canceling

campaign.subscription.subscribedAt

string

Timestamp (UTC) when the subscription became active.

campaign.subscription.updatedAt

string

Timestamp (UTC) when the subscription was last updated.

campaign.subscription.cancelledAt

string

Timestamp (UTC) when the subscription was cancelled.

campaign.status

string

Campaign status

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

campaign.usecase

string

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

campaign.subUsecases

array of string

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

campaign.description

string

A detailed description of what the campaign is for.

campaign.embeddedLink

boolean

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

campaign.embeddedPhone

boolean

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

campaign.numberPool

boolean

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

campaign.ageGated

boolean

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

campaign.directLending

boolean

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

campaign.subscriberOptin

boolean

Confirm customer opt in is collected and processed.

campaign.subscriberOptout

boolean

Confirm customer opt out is collected and processed.

campaign.subscriberHelp

boolean

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

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.

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.

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.

campaign.helpKeywords

string

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

campaign.optoutKeywords

string

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

campaign.optinKeywords

string

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

campaign.optinMessage

string

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

campaign.optoutMessage

string

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

campaign.termsAndConditions

boolean

Indicates the campaign follows CTIA messaging principles and best practices.

campaign.brandId

string

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

campaign.resellerId

string

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

campaign.rejection

object

Rejection details

Untergeordnete Attribute anzeigen

campaign.rejection.description

string

erforderlich

Rejection description

campaign.rejection.code

string

Rejection code

campaign.attachments

array of object

Attachments associated with this campaign.

Untergeordnete Attribute anzeigen

campaign.attachments.id

string

erforderlich

The ID of the attachment.

campaign.attachments.status

string

erforderlich

Attachment status

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

campaign.attachments.createdAt

string

erforderlich

Timestamp (UTC) when the attachment was created.

campaign.attachments.updatedAt

string

erforderlich

Timestamp (UTC) when the attachment was last updated.

campaign.attachments.filename

string

erforderlich

The original name of the file when it was uploaded.

campaign.attachments.mediaUrl

string

The URL to download the attachment.

campaign.attachments.contentType

string

erforderlich

The detected MIME type of the file.

campaign.createdAt

string

Timestamp (UTC) when the campaign was created.

campaign.updatedAt

string

Timestamp (UTC) when the campaign was last updated.

linkingStatus

string

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

reseller

object

Untergeordnete Attribute anzeigen

reseller.id

string

UUID of the reseller.

reseller.organizationId

string

reseller.status

string

Reseller status

Possible values: FAILED, PENDING, ACTIVE, DELETED

reseller.companyName

string

erforderlich

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

reseller.phone

string

erforderlich

Valid phone number in e.164 international format.

reseller.email

string

erforderlich

Valid email address of support contact.

reseller.createdAt

string

Timestamp (UTC) when the reseller was created.

reseller.updatedAt

string

Timestamp (UTC) when the reseller was last updated.

Codebeispiel

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