v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
partner

Add phone for risk verification

Add a phone number for a created user. BILL requires organization users 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/partner/risk-verifications/{userId}/phone

Path parameters

userIdstring required

BILL-generated ID of the user. The value begins with 006.

Example:{{partner_user_id}}

Headers

sessionIdstring nullable

API session ID generated with /v3/partner/login

Example:{{partner_session_id}}
appKeystring nullable

Application key sent to you by BILL when you create a partner account

Example:{{app_key}}
organizationIdstring nullable

BILL-generated ID of the organization

Example:{{partner_organization_id}}

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