Verify

API Reference

Contacts

Verify a contact

client.contacts.verify(ContactVerifyParams { number } body, RequestOptionsoptions?): ContactVerifyResponse { status }

post/api/v2/contacts/verify

Send a verification message to a contact

ParametersExpand Collapse

body: ContactVerifyParams { number }

number: string

Phone number to verify

ReturnsExpand Collapse

ContactVerifyResponse { status }

status?: string

Verify a contact

typescript

• http
• typescript
• python

import SendblueAPI from 'sendblue';

const client = new SendblueAPI({
  apiKey: 'My API Key',
  apiSecret: 'My API Secret',
});

const response = await client.contacts.verify({ number: 'number' });

console.log(response.status);

200 example

{
  "status": "OK"
}

Returns Examples

200 example

{
  "status": "OK"
}