v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
risk-verifications

Add phone for risk verification

Add a phone number for the currently signed-in user. BILL requires the signed-in user to have a linked phone number for initiating risk verification for the organization.

You can check whether a phone number has been added for the user with GET /v3/risk-verifications/phone.

After you add a phone number with this endpoint, you can initiate risk verification for the organization with POST /v3/risk-verifications.

post/v3/risk-verifications/phone

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}
devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Request body

phoneNumberstring required

Phone number

phoneType'MOBILE' | 'HOME' required

Phone type

Example request

{
  "phoneNumber": "{{user_phone_no}}",
  "phoneType": "MOBILE"
}

Response

Add phone for risk verification response