Add customer for screening

POST 
/workflows/:workflowId/customers

Add customer for screening

Request

Path Parameters

workflowId stringrequired

application/json

Body

required

customerData object[]
Array [
customerWallet object
wallet object required
anyOf
MOD1
string
MOD3
string
MOD4
string
MOD5
string
MOD6
string
MOD7
string
blockchainNamespace stringnullable
Possible values: [tezos, eip155, aptos, polkadot, starknet, cosmos, solana, cardano, bitcoin]
verified booleannullable
createdBy string
customerClaims object
sub stringnullable
name stringnullable
givenName stringnullable
familyName stringnullable
middleName stringnullable
nickname stringnullable
preferredUsername stringnullable
profile stringnullable
picture stringnullable
pictureBase64 stringnullable
website stringnullable
gender stringnullable
birthdate date-timenullable
zoneinfo stringnullable
locale stringnullable
countryOfResidence stringnullable
Possible values: [AFG, ALB, DZA, ASM, AND, AGO, AIA, ATA, ATG, ARG, ARM, ABW, AUS, AUT, AZE, BHS, BHR, BGD, BRB, BLR, BEL, BLZ, BEN, BMU, BTN, BOL, BES, BIH, BWA, BVT, BRA, IOT, BRN, BGR, BFA, BDI, CPV, KHM, CMR, CAN, CYM, CAF, TCD, CHL, CHN, CXR, CCK, COL, COM, COD, COG, COK, CRI, HRV, CUB, CUW, CYP, CZE, CIV, DNK, DJI, DMA, DOM, ECU, EGY, SLV, GNQ, ERI, EST, SWZ, ETH, FLK, FRO, FJI, FIN, FRA, GUF, PYF, ATF, GAB, GMB, GEO, DEU, GHA, GIB, GRC, GRL, GRD, GLP, GUM, GTM, GGY, GIN, GNB, GUY, HTI, HMD, VAT, HND, HKG, HUN, ISL, IND, IDN, IRN, IRQ, IRL, IMN, ISR, ITA, JAM, JPN, JEY, JOR, KAZ, KEN, KIR, PRK, KOR, KWT, KGZ, LAO, LVA, LBN, LSO, LBR, LBY, LIE, LTU, LUX, MAC, MDG, MWI, MYS, MDV, MLI, MLT, MHL, MTQ, MRT, MUS, MYT, MEX, FSM, MDA, MCO, MNG, MNE, MSR, MAR, MOZ, MMR, NAM, NRU, NPL, NLD, NCL, NZL, NIC, NER, NGA, NIU, NFK, MNP, NOR, OMN, PAK, PLW, PSE, PAN, PNG, PRY, PER, PHL, PCN, POL, PRT, PRI, QAT, MKD, ROU, RUS, RWA, REU, BLM, SHN, KNA, LCA, MAF, SPM, VCT, WSM, SMR, STP, SAU, SEN, SRB, SYC, SLE, SGP, SXM, SVK, SVN, SLB, SOM, ZAF, SGS, SSD, ESP, LKA, SDN, SUR, SJM, SWE, CHE, SYR, TWN, TJK, TZA, THA, TLS, TGO, TKL, TON, TTO, TUN, TUR, TKM, TCA, TUV, UGA, UKR, ARE, GBR, UMI, USA, URY, UZB, VUT, VEN, VNM, VGB, VIR, WLF, ESH, YEM, ZMB, ZWE, ALA, ANT, XKX]
Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)
nationality stringnullable
Possible values: [AFG, ALB, DZA, ASM, AND, AGO, AIA, ATA, ATG, ARG, ARM, ABW, AUS, AUT, AZE, BHS, BHR, BGD, BRB, BLR, BEL, BLZ, BEN, BMU, BTN, BOL, BES, BIH, BWA, BVT, BRA, IOT, BRN, BGR, BFA, BDI, CPV, KHM, CMR, CAN, CYM, CAF, TCD, CHL, CHN, CXR, CCK, COL, COM, COD, COG, COK, CRI, HRV, CUB, CUW, CYP, CZE, CIV, DNK, DJI, DMA, DOM, ECU, EGY, SLV, GNQ, ERI, EST, SWZ, ETH, FLK, FRO, FJI, FIN, FRA, GUF, PYF, ATF, GAB, GMB, GEO, DEU, GHA, GIB, GRC, GRL, GRD, GLP, GUM, GTM, GGY, GIN, GNB, GUY, HTI, HMD, VAT, HND, HKG, HUN, ISL, IND, IDN, IRN, IRQ, IRL, IMN, ISR, ITA, JAM, JPN, JEY, JOR, KAZ, KEN, KIR, PRK, KOR, KWT, KGZ, LAO, LVA, LBN, LSO, LBR, LBY, LIE, LTU, LUX, MAC, MDG, MWI, MYS, MDV, MLI, MLT, MHL, MTQ, MRT, MUS, MYT, MEX, FSM, MDA, MCO, MNG, MNE, MSR, MAR, MOZ, MMR, NAM, NRU, NPL, NLD, NCL, NZL, NIC, NER, NGA, NIU, NFK, MNP, NOR, OMN, PAK, PLW, PSE, PAN, PNG, PRY, PER, PHL, PCN, POL, PRT, PRI, QAT, MKD, ROU, RUS, RWA, REU, BLM, SHN, KNA, LCA, MAF, SPM, VCT, WSM, SMR, STP, SAU, SEN, SRB, SYC, SLE, SGP, SXM, SVK, SVN, SLB, SOM, ZAF, SGS, SSD, ESP, LKA, SDN, SUR, SJM, SWE, CHE, SYR, TWN, TJK, TZA, THA, TLS, TGO, TKL, TON, TTO, TUN, TUR, TKM, TCA, TUV, UGA, UKR, ARE, GBR, UMI, USA, URY, UZB, VUT, VEN, VNM, VGB, VIR, WLF, ESH, YEM, ZMB, ZWE, ALA, ANT, XKX]
Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)
createdBy stringrequired
address string
customerDid object
did stringrequired
createdBy string
updatedBy string
]
customerDocument object
fileName stringrequired
mimetype stringrequired
documentType stringrequired
Possible values: [proof_of_residence, company_document, video_kyc]
existingDocumentKey string
metadata object required
anyOf
MOD1
sumsubImageId numberrequired
mediaType stringrequired
Possible values: [image/jpg, image/jpeg, image/png, application/pdf, video/mp4, video/webm, video/quicktime]
journeyId stringrequired
documentType stringrequired
Possible values: [INCORPORATION_CERT, INCORPORATION_ARTICLES, SHAREHOLDER_REGISTRY]
name string
entryDate integerrequired
entryTime stringrequired
isSandbox booleanrequired
MOD2
journeyId uuidrequired
The ID of the journey that this credential is associated with
country string
Possible values: [AFG, ALB, DZA, ASM, AND, AGO, AIA, ATA, ATG, ARG, ARM, ABW, AUS, AUT, AZE, BHS, BHR, BGD, BRB, BLR, BEL, BLZ, BEN, BMU, BTN, BOL, BES, BIH, BWA, BVT, BRA, IOT, BRN, BGR, BFA, BDI, CPV, KHM, CMR, CAN, CYM, CAF, TCD, CHL, CHN, CXR, CCK, COL, COM, COD, COG, COK, CRI, HRV, CUB, CUW, CYP, CZE, CIV, DNK, DJI, DMA, DOM, ECU, EGY, SLV, GNQ, ERI, EST, SWZ, ETH, FLK, FRO, FJI, FIN, FRA, GUF, PYF, ATF, GAB, GMB, GEO, DEU, GHA, GIB, GRC, GRL, GRD, GLP, GUM, GTM, GGY, GIN, GNB, GUY, HTI, HMD, VAT, HND, HKG, HUN, ISL, IND, IDN, IRN, IRQ, IRL, IMN, ISR, ITA, JAM, JPN, JEY, JOR, KAZ, KEN, KIR, PRK, KOR, KWT, KGZ, LAO, LVA, LBN, LSO, LBR, LBY, LIE, LTU, LUX, MAC, MDG, MWI, MYS, MDV, MLI, MLT, MHL, MTQ, MRT, MUS, MYT, MEX, FSM, MDA, MCO, MNG, MNE, MSR, MAR, MOZ, MMR, NAM, NRU, NPL, NLD, NCL, NZL, NIC, NER, NGA, NIU, NFK, MNP, NOR, OMN, PAK, PLW, PSE, PAN, PNG, PRY, PER, PHL, PCN, POL, PRT, PRI, QAT, MKD, ROU, RUS, RWA, REU, BLM, SHN, KNA, LCA, MAF, SPM, VCT, WSM, SMR, STP, SAU, SEN, SRB, SYC, SLE, SGP, SXM, SVK, SVN, SLB, SOM, ZAF, SGS, SSD, ESP, LKA, SDN, SUR, SJM, SWE, CHE, SYR, TWN, TJK, TZA, THA, TLS, TGO, TKL, TON, TTO, TUN, TUR, TKM, TCA, TUV, UGA, UKR, ARE, GBR, UMI, USA, URY, UZB, VUT, VEN, VNM, VGB, VIR, WLF, ESH, YEM, ZMB, ZWE, ALA, ANT, XKX]
The country of residence - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)
name string
Name of the document (e.g. ProofOfResidence.jpg)
documentType stringrequired
Possible values: [Gas_bill, Internet_bill, Electricity_bill, Rent_agreement, Bank_statement]
Type of the document (e.g. Gas bill, Internet bill, Electricity bill, Rent agreement, Bank statement)
entryDate integerrequired
Entry date associated with the credential
entryTime stringrequired
Entry time associated with the credential
mediaType string
Possible values: [image/jpeg, image/jpg, image/png, application/pdf]
Media type of the document (e.g. image/jpeg, image/png, application/pdf)
county string
The county of residence
city string
The city of residence
streetName string
The street name of residence
postalCode string
The postal code of residence
isSandbox boolean
Indicates if the credential was generated in a sandbox environment
MOD3
id stringrequired
journeyId stringrequired
reviewStatus stringrequired
roomId stringrequired
moderatorDisplayName stringrequired
customerPersonalData object

credentials object[]required

Array [

id stringrequired

@context string[]

type string[]required

expirationDate string

issuanceDate string

credentialSubject objectrequired

credentialStatus objectrequired

id stringrequired

type stringrequired

Possible values: [SparseMerkleTreeProof, Iden3ReverseSparseMerkleTreeProof, Iden3commRevocationStatusV1.0, Iden3OnchainSparseMerkleTreeProof2023]

revocationNonce number

issuer stringrequired

credentialSchema objectrequired

id stringrequired

type stringrequired

proof

]

requestIp stringnullable

address object nullable

anyOf

MOD1

string

MOD3

string

MOD4

string

MOD5

string

MOD6

string

MOD7

string

workspaceId stringrequired
organizationId stringrequired
contactInformation object
email email
phone string
Possible values: >= 4 characters
twitter string
discord string
telegram string

Responses

200

Successful response

application/json

Schema

Schema

msg stringrequired

Example (from schema)

{
  "msg": "string"
}

default

Error response

application/json

Schema

Schema

message stringrequired
code stringrequired
issues object[]
Array [
message stringrequired
]

Example (from schema)

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Loading...