Skip to main content
POST
Create a client

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the dashboard.

X-Environment
string
header
required

Target environment for the request. Must be "test" or "live".

Body

application/json
type
any
required

Type

name
string
required

Name

Minimum string length: 1
scopes
enum<string>[]
required
Minimum array length: 1
Available options:
base,
MX:AV,
MX:AV:ARI,
MX:AV:AVI,
MX:AV:INM,
MX:AV:JYS,
MX:AV:MJR,
MX:AV:MPC,
MX:AV:TSC,
MX:AV:VEH,
MX:CNBV,
MX:CNBV:TRANSMISOR,
MX
nationalities

Nationalities

externalId
string

External ID

metadata
object

Metadata

birthDate
string<date>

Birth Date

middleName
string

Middle Name

lastName

Last Name

Minimum string length: 1
employment
object

Employment

scopeData
object

Response

200 - application/json

OK

type
any
required

Type

name
string
required

Name

Minimum string length: 1
scopes
enum<string>[]
required
Minimum array length: 1
Available options:
base,
MX:AV,
MX:AV:ARI,
MX:AV:AVI,
MX:AV:INM,
MX:AV:JYS,
MX:AV:MJR,
MX:AV:MPC,
MX:AV:TSC,
MX:AV:VEH,
MX:CNBV,
MX:CNBV:TRANSMISOR,
MX
id
string<uuid>
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
isPrimary
boolean
required
nationalities
any

Nationalities

externalId
string

External ID

metadata
object

Metadata

birthDate
string<date>

Birth Date

middleName
string

Middle Name

lastName
any

Last Name

employment
object

Employment

scopeData
object
email
string | null
phone
string | null
age
integer | null
Required range: -9007199254740991 <= x <= 9007199254740991
addresses
object[]
contactMethods
object[]
bankAccounts
object[]
documents
object[]
linkedClients
object[]
riskAssessments
object
tags
object[]