Update employee

Employee

Update employee

PUT

https://agents-api-sit.finci.com:5500/v1/update-employee/{employee_id}

Updates the stored details for an existing employee record identified by employee_id.

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).

Path parameters

employee_id

string

Required

Employee ID

Request body

corporate_id

string

Required

Corporate ID

Examples:

10011100000000000001

external_id

string

Required

External ID. Must be unique for every employee.

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

last_name

string

Required

Last name

first_name

string

Required

First name

mobile_phone

string

Required

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

home_address

object

Required

Home 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

Response

Employee updated

status

string

success

string

error

string

errors

array of string

Error codes list

employee_id

string

Employee ID

Examples:

10011100000000000001

Example request

curl --request PUT \
     --url https://agents-api-sit.finci.com:5500/v1/update-employee/stringstringstringst \
     --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 '
{
  "corporate_id": "10011100000000000001",
  "external_id": "string",
  "residence_country_code": "ABW",
  "last_name": "string",
  "first_name": "string",
  "mobile_phone": "stringstr",
  "home_address": {
    "country": "ABW",
    "city": "string",
    "zip": "string",
    "address": "string",
    "address2": "string"
  }
}
'

Example response

{
  "status": "success",
  "errors": [
    "string"
  ],
  "employee_id": "10011100000000000001"
}

Create employee Get employee

Built with