Antifraud1

API validations3

Authentications1

Curp validation2

Custom fields2

Custom watchlist5

Document capture6

Electronic signature3

Electronic signature advanced1

Email input2

Face capture3

Fiscal qr url3

Forms and data entry1

Geolocation1

Global watchlist3

Government validation1

Id capture16

Identities1

Interview32

Nom1514

Onboarding1

Organization4

Phone number input4

Proof of address capture2

Shared consent2

User consent2

Video conference5

Videoselfie2

Phone number input

Add phone

Add phone to interview

post/omni/phone

Request

Base URL
https://demo-api.incodesmile.com
Auth
API key in header x-api-key and API key in header X-Incode-Hardware-Id
TypeScript
https://skmtc.dev/incode/apis/incode-omni-api/docs/omni/phone/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

api-versionstring required

Request body

phonestring

User's phone number. E.164 number convention.

optInGrantedboolean

Indicates whether opt-in is granted

Example request

{
  "phone": "+1111111"
}

Response

successboolean

Flag indicating request passed successfully.

sessionStatus'Alive' | 'Closed' | 'Deleted'

Session status

existingCustomerboolean

Flag indicating if this user with given phone already exists in the system.

Changes

No recorded changes to this operation across all 1 revision of this API.