Sumsub SDK

Appearance

Interface: ApplicantsAddIdDocumentMetadataValue ​

Describes the structure of the metadata parameter of metadata

Work with applicants ​

country ​

• country: string

ISO 3166-1 alpha-3 country code.

See

Add ID document API Reference

Defined in ​

src/client.ts:353

dob ​

• Optional dob: string

The applicant date of birth.

See

Add ID document API Reference

Defined in ​

src/client.ts:365

firstName ​

• Optional firstName: string

The first applicant name.

See

Add ID document API Reference

Defined in ​

src/client.ts:371

idDocSubType ​

• Optional idDocSubType: string

FRONT_SIDE, BACK_SIDE or null.

See

Add ID document API Reference

Defined in ​

src/client.ts:377

idDocType ​

• idDocType: string

A document type.

See

Add ID document API Reference

Defined in ​

src/client.ts:359

issuedDate ​

• Optional issuedDate: string

Issued date (format YYYY-mm-dd, e.g. 2001-09-25).

See

Add ID document API Reference

Defined in ​

src/client.ts:383

lastName ​

• Optional lastName: string

The last applicant name.

See

Add ID document API Reference

Defined in ​

src/client.ts:389

middleName ​

• Optional middleName: string

The middle applicant name.

See

Add ID document API Reference

Defined in ​

src/client.ts:395

number ​

• Optional number: string

A document number.

See

Add ID document API Reference

Defined in ​

src/client.ts:401

placeOfBirth ​

• Optional placeOfBirth: string

The applicant birthplace.

See

Add ID document API Reference

Defined in ​

src/client.ts:407

validUntil ​

• Optional validUntil: string

Valid until date (format YYYY-mm-dd, e.g. 2001-09-26).

See

Add ID document API Reference

Defined in ​

src/client.ts:413