Create a client

Person

Create a client

POST

https://agents-api-sit.finci.com:5500/v1/create-client

Creates a private-person record together with its initial account information.

Headers

X-Auth-Token

string

Required

Partner Token

X-Auth-Signature

string

Required

Signature of the request body

X-Auth-Timestamp

string

Required

Request timestamp (Unix Epoch in UTC).

Request body

external_id

string

Required

External ID. Must be unique for every person.

person_type

string

Required

Person Type

basic

string

premium

string

last_name

string

Required

Last name. Allowed case-insensitive characters.

first_name

string

Required

First name. Allowed case-insensitive characters.

gender

string

Required

Gender, M - male, F - Female, N - Not specified

M

string

F

string

N

string

birth_date

string

Required

Birth date, YYYY-MM-DD format, for example "1990-12-14"

mobile_phone

string

Required

Mobile phone number in E.164 format using plus sign followed by 8 to 15 digits.

residence_country_code

string

Required

ABW

string

AFG

string

AGO

string

AIA

string

ALA

string

ALB

string

AND

string

ARE

string

ARG

string

ARM

string

ASM

string

ATA

string

ATF

string

ATG

string

AUS

string

AUT

string

AZE

string

BDI

string

BEL

string

BEN

string

BES

string

BFA

string

BGD

string

BGR

string

BHR

string

BHS

string

BIH

string

BLM

string

BLR

string

BLZ

string

BMU

string

BOL

string

BRA

string

BRB

string

BRN

string

BTN

string

BVT

string

BWA

string

CAF

string

CAN

string

CCK

string

CHE

string

CHL

string

CHN

string

CIV

string

CMR

string

COD

string

COG

string

COK

string

COL

string

COM

string

CPV

string

CRI

string

CUB

string

CUW

string

CXR

string

CYM

string

CYP

string

CZE

string

DEU

string

DJI

string

DMA

string

DNK

string

DOM

string

DZA

string

ECU

string

EGY

string

ERI

string

ESH

string

ESP

string

EST

string

ETH

string

FIN

string

FJI

string

FLK

string

FRA

string

FRO

string

FSM

string

GAB

string

GBR

string

GEO

string

GGY

string

GHA

string

GIB

string

GIN

string

GLP

string

GMB

string

GNB

string

GNQ

string

GRC

string

GRD

string

GRL

string

GTM

string

GUF

string

GUM

string

GUY

string

HKG

string

HMD

string

HND

string

HRV

string

HTI

string

HUN

string

IDN

string

IMN

string

IND

string

IOT

string

IRL

string

IRN

string

IRQ

string

ISL

string

ISR

string

ITA

string

JAM

string

JEY

string

JOR

string

JPN

string

KAZ

string

KEN

string

KGZ

string

KHM

string

KIR

string

KNA

string

KOR

string

KWT

string

LAO

string

LBN

string

LBR

string

LBY

string

LCA

string

LIE

string

LKA

string

LSO

string

LTU

string

LUX

string

LVA

string

MAC

string

MAF

string

MAR

string

MCO

string

MDA

string

MDG

string

MDV

string

MEX

string

MHL

string

MKD

string

MLI

string

MLT

string

MMR

string

MNE

string

MNG

string

MNP

string

MOZ

string

MRT

string

MSR

string

MTQ

string

MUS

string

MWI

string

MYS

string

MYT

string

NAM

string

NCL

string

NER

string

NFK

string

NGA

string

NIC

string

NIU

string

NLD

string

NOR

string

NPL

string

NRU

string

NZL

string

OMN

string

PAK

string

PAN

string

PCN

string

PER

string

PHL

string

PLW

string

PNG

string

POL

string

PRI

string

PRK

string

PRT

string

PRY

string

PSE

string

PYF

string

QAT

string

REU

string

ROU

string

RUS

string

RWA

string

SAU

string

SDN

string

SEN

string

SGP

string

SGS

string

SHN

string

SJM

string

SLB

string

SLE

string

SLV

string

SMR

string

SOM

string

SPM

string

SRB

string

SSD

string

STP

string

SUR

string

SVK

string

SVN

string

SWE

string

SWZ

string

SXM

string

SYC

string

SYR

string

TCA

string

TCD

string

TGO

string

THA

string

TJK

string

TKL

string

TKM

string

TLS

string

TON

string

TTO

string

TUN

string

TUR

string

TUV

string

TWN

string

TZA

string

UGA

string

UKR

string

UMI

string

UNK

string

URY

string

USA

string

UZB

string

VAT

string

VCT

string

VEN

string

VGB

string

VIR

string

VNM

string

VUT

string

WLF

string

WSM

string

YEM

string

ZAF

string

ZMB

string

ZWE

string

mail_address

object

Required

Mailing address

country

string

ABW

string

AFG

string

AGO

string

AIA

string

ALA

string

ALB

string

AND

string

ARE

string

ARG

string

ARM

string

ASM

string

ATA

string

ATF

string

ATG

string

AUS

string

AUT

string

AZE

string

BDI

string

BEL

string

BEN

string

BES

string

BFA

string

BGD

string

BGR

string

BHR

string

BHS

string

BIH

string

BLM

string

BLR

string

BLZ

string

BMU

string

BOL

string

BRA

string

BRB

string

BRN

string

BTN

string

BVT

string

BWA

string

CAF

string

CAN

string

CCK

string

CHE

string

CHL

string

CHN

string

CIV

string

CMR

string

COD

string

COG

string

COK

string

COL

string

COM

string

CPV

string

CRI

string

CUB

string

CUW

string

CXR

string

CYM

string

CYP

string

CZE

string

DEU

string

DJI

string

DMA

string

DNK

string

DOM

string

DZA

string

ECU

string

EGY

string

ERI

string

ESH

string

ESP

string

EST

string

ETH

string

FIN

string

FJI

string

FLK

string

FRA

string

FRO

string

FSM

string

GAB

string

GBR

string

GEO

string

GGY

string

GHA

string

GIB

string

GIN

string

GLP

string

GMB

string

GNB

string

GNQ

string

GRC

string

GRD

string

GRL

string

GTM

string

GUF

string

GUM

string

GUY

string

HKG

string

HMD

string

HND

string

HRV

string

HTI

string

HUN

string

IDN

string

IMN

string

IND

string

IOT

string

IRL

string

IRN

string

IRQ

string

ISL

string

ISR

string

ITA

string

JAM

string

JEY

string

JOR

string

JPN

string

KAZ

string

KEN

string

KGZ

string

KHM

string

KIR

string

KNA

string

KOR

string

KWT

string

LAO

string

LBN

string

LBR

string

LBY

string

LCA

string

LIE

string

LKA

string

LSO

string

LTU

string

LUX

string

LVA

string

MAC

string

MAF

string

MAR

string

MCO

string

MDA

string

MDG

string

MDV

string

MEX

string

MHL

string

MKD

string

MLI

string

MLT

string

MMR

string

MNE

string

MNG

string

MNP

string

MOZ

string

MRT

string

MSR

string

MTQ

string

MUS

string

MWI

string

MYS

string

MYT

string

NAM

string

NCL

string

NER

string

NFK

string

NGA

string

NIC

string

NIU

string

NLD

string

NOR

string

NPL

string

NRU

string

NZL

string

OMN

string

PAK

string

PAN

string

PCN

string

PER

string

PHL

string

PLW

string

PNG

string

POL

string

PRI

string

PRK

string

PRT

string

PRY

string

PSE

string

PYF

string

QAT

string

REU

string

ROU

string

RUS

string

RWA

string

SAU

string

SDN

string

SEN

string

SGP

string

SGS

string

SHN

string

SJM

string

SLB

string

SLE

string

SLV

string

SMR

string

SOM

string

SPM

string

SRB

string

SSD

string

STP

string

SUR

string

SVK

string

SVN

string

SWE

string

SWZ

string

SXM

string

SYC

string

SYR

string

TCA

string

TCD

string

TGO

string

THA

string

TJK

string

TKL

string

TKM

string

TLS

string

TON

string

TTO

string

TUN

string

TUR

string

TUV

string

TWN

string

TZA

string

UGA

string

UKR

string

UMI

string

UNK

string

URY

string

USA

string

UZB

string

VAT

string

VCT

string

VEN

string

VGB

string

VIR

string

VNM

string

VUT

string

WLF

string

WSM

string

YEM

string

ZAF

string

ZMB

string

ZWE

string

city

string

City

zip

string

Zip

address

string

Address line 1

address2

string

Address line 2

reg_address

object

Required

Registration address

country

string

ABW

string

AFG

string

AGO

string

AIA

string

ALA

string

ALB

string

AND

string

ARE

string

ARG

string

ARM

string

ASM

string

ATA

string

ATF

string

ATG

string

AUS

string

AUT

string

AZE

string

BDI

string

BEL

string

BEN

string

BES

string

BFA

string

BGD

string

BGR

string

BHR

string

BHS

string

BIH

string

BLM

string

BLR

string

BLZ

string

BMU

string

BOL

string

BRA

string

BRB

string

BRN

string

BTN

string

BVT

string

BWA

string

CAF

string

CAN

string

CCK

string

CHE

string

CHL

string

CHN

string

CIV

string

CMR

string

COD

string

COG

string

COK

string

COL

string

COM

string

CPV

string

CRI

string

CUB

string

CUW

string

CXR

string

CYM

string

CYP

string

CZE

string

DEU

string

DJI

string

DMA

string

DNK

string

DOM

string

DZA

string

ECU

string

EGY

string

ERI

string

ESH

string

ESP

string

EST

string

ETH

string

FIN

string

FJI

string

FLK

string

FRA

string

FRO

string

FSM

string

GAB

string

GBR

string

GEO

string

GGY

string

GHA

string

GIB

string

GIN

string

GLP

string

GMB

string

GNB

string

GNQ

string

GRC

string

GRD

string

GRL

string

GTM

string

GUF

string

GUM

string

GUY

string

HKG

string

HMD

string

HND

string

HRV

string

HTI

string

HUN

string

IDN

string

IMN

string

IND

string

IOT

string

IRL

string

IRN

string

IRQ

string

ISL

string

ISR

string

ITA

string

JAM

string

JEY

string

JOR

string

JPN

string

KAZ

string

KEN

string

KGZ

string

KHM

string

KIR

string

KNA

string

KOR

string

KWT

string

LAO

string

LBN

string

LBR

string

LBY

string

LCA

string

LIE

string

LKA

string

LSO

string

LTU

string

LUX

string

LVA

string

MAC

string

MAF

string

MAR

string

MCO

string

MDA

string

MDG

string

MDV

string

MEX

string

MHL

string

MKD

string

MLI

string

MLT

string

MMR

string

MNE

string

MNG

string

MNP

string

MOZ

string

MRT

string

MSR

string

MTQ

string

MUS

string

MWI

string

MYS

string

MYT

string

NAM

string

NCL

string

NER

string

NFK

string

NGA

string

NIC

string

NIU

string

NLD

string

NOR

string

NPL

string

NRU

string

NZL

string

OMN

string

PAK

string

PAN

string

PCN

string

PER

string

PHL

string

PLW

string

PNG

string

POL

string

PRI

string

PRK

string

PRT

string

PRY

string

PSE

string

PYF

string

QAT

string

REU

string

ROU

string

RUS

string

RWA

string

SAU

string

SDN

string

SEN

string

SGP

string

SGS

string

SHN

string

SJM

string

SLB

string

SLE

string

SLV

string

SMR

string

SOM

string

SPM

string

SRB

string

SSD

string

STP

string

SUR

string

SVK

string

SVN

string

SWE

string

SWZ

string

SXM

string

SYC

string

SYR

string

TCA

string

TCD

string

TGO

string

THA

string

TJK

string

TKL

string

TKM

string

TLS

string

TON

string

TTO

string

TUN

string

TUR

string

TUV

string

TWN

string

TZA

string

UGA

string

UKR

string

UMI

string

UNK

string

URY

string

USA

string

UZB

string

VAT

string

VCT

string

VEN

string

VGB

string

VIR

string

VNM

string

VUT

string

WLF

string

WSM

string

YEM

string

ZAF

string

ZMB

string

ZWE

string

city

string

City

zip

string

Zip

address

string

Address line 1

address2

string

Address line 2

account

object

Required

Account information

currency_code

string

Defaults: EUR

AED

string

AFN

string

ALL

string

AMD

string

ANG

string

AOA

string

ARS

string

AUD

string

AWG

string

AZN

string

BAM

string

BBD

string

BDT

string

BGN

string

BHD

string

BIF

string

BMD

string

BND

string

BOB

string

BOV

string

BRL

string

BSD

string

BTN

string

BWP

string

BYN

string

BZD

string

CAD

string

CDF

string

CHE

string

CHF

string

CHW

string

CLF

string

CLP

string

CNY

string

COP

string

COU

string

CRC

string

CUC

string

CUP

string

CVE

string

CZK

string

DJF

string

DKK

string

DOP

string

DZD

string

EGP

string

ERN

string

ETB

string

EUR

string

FJD

string

FKP

string

GBP

string

GEL

string

GHS

string

GIP

string

GMD

string

GNF

string

GTQ

string

GYD

string

HKD

string

HNL

string

HRK

string

HTG

string

HUF

string

IDR

string

ILS

string

INR

string

IQD

string

IRR

string

ISK

string

JMD

string

JOD

string

JPY

string

KES

string

KGS

string

KHR

string

KMF

string

KPW

string

KRW

string

KWD

string

KYD

string

KZT

string

LAK

string

LBP

string

LKR

string

LRD

string

LSL

string

LYD

string

MAD

string

MDL

string

MGA

string

MKD

string

MMK

string

MNT

string

MOP

string

MRU

string

MUR

string

MVR

string

MWK

string

MXN

string

MXV

string

MYR

string

MZN

string

NAD

string

NGN

string

NIO

string

NOK

string

NPR

string

NZD

string

OMR

string

PAB

string

PEN

string

PGK

string

PHP

string

PKR

string

PLN

string

PYG

string

QAR

string

RON

string

RSD

string

RUB

string

RWF

string

SAR

string

SBD

string

SCR

string

SDG

string

SEK

string

SGD

string

SHP

string

SLL

string

SOS

string

SRD

string

SSP

string

STN

string

SVC

string

SYP

string

SZL

string

THB

string

TJS

string

TMT

string

TND

string

TOP

string

TRY

string

TTD

string

TWD

string

TZS

string

UAH

string

UGX

string

USD

string

USN

string

UYI

string

UYU

string

UYW

string

UZS

string

VES

string

VND

string

VUV

string

WST

string

XAF

string

XCD

string

XOF

string

XPF

string

YER

string

ZAR

string

ZMW

string

ZWL

string

XBT

string

ETH

string

USC

string

UST

string

external_number

string

External Number. Must be unique for every account. Digits only, 6 to 20 characters.

Response

Client created

status

string

success

string

error

string

errors

array of string

Error codes list

person_id

string

Person ID

Examples:

10011000000000000001

Example request

curl --request POST \
     --url https://agents-api-sit.finci.com:5500/v1/create-client \
     --header 'X-Auth-Signature: string' \
     --header 'X-Auth-Timestamp: string' \
     --header 'X-Auth-Token: string' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "external_id": "string",
  "person_type": "basic",
  "last_name": "string",
  "first_name": "string",
  "gender": "M",
  "birth_date": "string",
  "mobile_phone": "stringstr",
  "residence_country_code": "ABW",
  "mail_address": {
    "country": "ABW",
    "city": "string",
    "zip": "string",
    "address": "string",
    "address2": "string"
  },
  "reg_address": {
    "country": "ABW",
    "city": "string",
    "zip": "string",
    "address": "string",
    "address2": "string"
  },
  "account": {
    "currency_code": "AED",
    "external_number": "string"
  }
}
'

Example response

{
  "status": "success",
  "errors": [
    "string"
  ],
  "person_id": "10011000000000000001"
}

Update client account

Built with