Skip to main content

Verify CSR phone number coverage

POST 

/customer_service_records/phone_number_coverages

Verify the coverage for a list of phone numbers.

Request

Body

required

    phone_numbers string[]required

    Possible values: Value must match regular expression ^\+1\d{10}$

    The phone numbers list to be verified.

Responses

201: Successful Response

Schema

    data

    object[]

  • Array [

  • phone_number string

    The phone number that is being verified.

    has_csr_coverage boolean

    Indicates whether the phone number is covered or not.

    reason string

    The reason why the phone number is not covered. Only returned if has_csr_coverage is false.

    additional_data_required string[]

    Possible values: [name, authorized_person_name, account_number, customer_code, pin, address_line_1, city, state, zip_code, billing_phone_number]

    Additional data required to perform CSR for the phone number. Only returned if has_csr_coverage is true.

    record_type string

    Identifies the type of the resource.

  • ]

401: The required authentication headers were either invalid or not included in the request.

Schema

    errors object[]

403: You do not have permission to perform the requested action on the specified resource or resources.

Schema

    errors object[]

422: Unprocessable entity. Check the 'detail' field in response for details.

Schema

    errors object[]

500: An unexpected error occurred.

Schema

    errors object[]
Loading...