Skip to main content

createAccount

Create a new user account. The provided userID must be unique.

createAccount(
  businessPhone: String
  duns: String
  businessStreet: JSON
  businessState: String
  businessZip: String
  userID: String
  email: String
  equifaxID: String
  meta: JSON
  businessFacts: BusinessInformation
  businessCity: String
  experianBIN: String
  syncWait: Int
  programCode: String
  planCode: PlanCode
  businessProfileID: String
  businessName: String
  businessAddress: String
): Account

Arguments​

createAccount.businessPhone ● String scalar​

A phone number in E.164 format. For US numbers this is the 10 digit number prefixed with +1. Example: +18552268388

createAccount.duns ● String scalar​

The business's 9 digit Dun and Bradstreet number Example: 072959232

createAccount.businessStreet ● JSON scalar​

The business street address, represented as an array of strings, with one string per line. Example: ['The White House', '1600 Pennsylvania Av.']

createAccount.businessState ● String scalar​

The two-letter code for the state in which the address city is located Example: DC

createAccount.businessZip ● String scalar​

The 5 or 9 digit zip code where the address is located

createAccount.userID ● String scalar​

Partner-provided user ID string. Example: user_nqf478fhia4f

createAccount.email ● String scalar​

Email address where notifications will be sent.

createAccount.equifaxID ● String scalar​

The business's 9 digit equifax identifier Example: 700325241

createAccount.meta ● JSON scalar​

Optional field for partner specific parameters.

createAccount.businessFacts ● BusinessInformation input​

An optional object containing business facts which we will store and retrieve for that business

createAccount.businessCity ● String scalar​

The city in which the address is located Example: Washington

createAccount.experianBIN ● String scalar​

The business's 9 digit alphanumeric Experian identifier Example: 700325241

createAccount.syncWait ● Int scalar​

DEPRECATED. Maximum number of seconds to wait for reports to be pulled, before returning.

createAccount.programCode ● String scalar​

An optional program code. If present the account will be created on the given program. Program codes are partner specific - you cannot use another partners program nor can they use yours. If no program is given, the account will be created with the default program code you were configured with.

createAccount.planCode ● PlanCode enum​

Deprecated planCode supported temporarily for legacy clients.

createAccount.businessProfileID ● String scalar​

DEPRECATED

createAccount.businessName ● String scalar​

The name of the business

createAccount.businessAddress ● String scalar​

The business street address Example: 1600 Pennsylvania Av. DEPRECATED. Use businessStreet instead.

Type​

Account object​

An end user.