{"openapi":"3.0.3","info":{"title":"ComPilot OpenAPI specification","version":"1.0.0","description":"The ComPilot API is a RESTful API that allows you to interact programmatically with ComPilot.\n\nAPI calls need to be authorized using HTTP bearer authorization, where the API key is used as the token.\n\nAPI calls are limited to 15 per second with a maximum of 300 per minute."},"servers":[{"url":"https://api.dzprivatbank.compilot.ai","description":"dzprivatbank"}],"externalDocs":{"url":"https://docs.compilot.ai","description":"ComPilot Documentation"},"paths":{"/companies/{customerId}/claims":{"post":{"operationId":"companiesRouter-claims-createCompanyCustomerClaim","summary":"Create a company claim. Only one company claim per company allowed.","description":"Create company claim.","tags":["Company"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sub":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"registrationNumber":{"type":"string","nullable":true},"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)"},"legalAddress":{"type":"string","nullable":true},"incorporatedOn":{"type":"string","format":"date-time"},"type":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"controlScheme":{"type":"string","nullable":true},"taxId":{"type":"string","nullable":true},"registrationLocation":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"postalAddress":{"type":"string","nullable":true},"createdBy":{"type":"string"},"addresses":{"type":"array","items":{"type":"string"}},"beneficiaries":{"type":"array","items":{"type":"object","properties":{"applicantId":{"type":"string","nullable":true},"type":{"type":"string","enum":["ubo","shareholder","representative","director"],"nullable":true},"inRegistry":{"type":"boolean","nullable":true},"types":{"type":"array","items":{"type":"string","enum":["ubo","shareholder","representative","director"]},"nullable":true},"positions":{"type":"array","items":{"type":"string"},"nullable":true},"imageIds":{"type":"array","items":{"type":"string"},"nullable":true},"shareSize":{"type":"number","nullable":true}},"additionalProperties":false}}},"additionalProperties":false},"example":{"sub":"example","companyName":"Jane Doe","registrationNumber":"example","country":"AFG","legalAddress":"Alexanderplatz 1, 10178 Berlin, Germany","incorporatedOn":"2024-05-14T09:30:00.000Z","type":"DEFAULT","email":"jane.doe@example.com","phone":"+4915112345678","controlScheme":"example","taxId":"example","registrationLocation":"example","website":"example","postalAddress":"10178","createdBy":"workspace","addresses":["Alexanderplatz 1, 10178 Berlin, Germany"],"beneficiaries":[{"applicantId":"example","type":"ubo","inRegistry":true,"types":["ubo"],"positions":["example"],"imageIds":["example"],"shareSize":42}]}}}},"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"sub":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"registrationNumber":{"type":"string","nullable":true},"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"legalAddress":{"type":"string","nullable":true},"incorporatedOn":{"type":"string","format":"date-time"},"type":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"controlScheme":{"type":"string","nullable":true},"taxId":{"type":"string","nullable":true},"registrationLocation":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"postalAddress":{"type":"string","nullable":true},"updatedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"addresses":{"type":"array","items":{"type":"string"},"nullable":true},"beneficiaries":{"type":"array","items":{"type":"object","properties":{"applicantId":{"type":"string","nullable":true},"type":{"type":"string","enum":["ubo","shareholder","representative","director"],"nullable":true},"inRegistry":{"type":"boolean","nullable":true},"types":{"type":"array","items":{"type":"string","enum":["ubo","shareholder","representative","director"]},"nullable":true},"positions":{"type":"array","items":{"type":"string"},"nullable":true},"imageIds":{"type":"array","items":{"type":"string"},"nullable":true},"shareSize":{"type":"number","nullable":true}},"additionalProperties":false}}},"required":["id","customerId","sub","companyName","registrationNumber","legalAddress","type","email","phone","controlScheme","taxId","registrationLocation","website","postalAddress","updatedAt","createdAt","createdBy","updatedBy","beneficiaries"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","sub":"example","companyName":"Jane Doe","registrationNumber":"example","country":"AFG","legalAddress":"Alexanderplatz 1, 10178 Berlin, Germany","incorporatedOn":"2024-05-14T09:30:00.000Z","type":"DEFAULT","email":"jane.doe@example.com","phone":"+4915112345678","controlScheme":"example","taxId":"example","registrationLocation":"example","website":"example","postalAddress":"10178","updatedAt":"2024-05-14T09:30:00.000Z","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","addresses":["Alexanderplatz 1, 10178 Berlin, Germany"],"beneficiaries":[{"applicantId":"example","type":"ubo","inRegistry":true,"types":["ubo"],"positions":["example"],"imageIds":["example"],"shareSize":42}]}}}},"default":{"$ref":"#/components/responses/error"}}}},"/companies/{customerId}/claims/{id}":{"delete":{"operationId":"companiesRouter-claims-deleteCompanyCustomerClaim","summary":"Delete company customer claim","description":"Delete the company customer claim.","tags":["Company"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}}},"default":{"$ref":"#/components/responses/error"}}}},"/companies/{customerId}/wallets":{"get":{"operationId":"companiesRouter-wallets-getCompanyWallets","summary":"Get company wallets","description":"Get all wallets for a company.","tags":["Companies"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]},"blockchainNamespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"],"nullable":true},"customerId":{"type":"string","format":"uuid"},"verified":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","wallet","customerId","verified","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"example":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","blockchainNamespace":"tezos","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}]}}},"default":{"$ref":"#/components/responses/error"}}},"post":{"operationId":"companiesRouter-wallets-createCompanyWallet","summary":"Add company wallet","description":"Add a new wallet for a company.","tags":["Companies"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]},"blockchainNamespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"],"nullable":true},"verified":{"type":"boolean","nullable":true}},"required":["wallet"],"additionalProperties":false},"example":{"wallet":"example","blockchainNamespace":"tezos","verified":true}}}},"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]},"blockchainNamespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"],"nullable":true},"customerId":{"type":"string","format":"uuid"},"verified":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","wallet","customerId","verified","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","blockchainNamespace":"tezos","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/companies/{customerId}/wallets/{id}":{"delete":{"operationId":"companiesRouter-wallets-deleteCompanyWallet","summary":"Delete company wallet","description":"Delete a company's wallet.","tags":["Companies"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/companies/wallets/rescore/{id}":{"post":{"operationId":"companiesRouter-wallets-reScoreWallet","summary":"Re score companies wallet","description":"Re score a company's wallet.","tags":["Companies"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"example"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]},"blockchainNamespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"],"nullable":true},"customerId":{"type":"string","format":"uuid"},"verified":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","wallet","customerId","verified","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","blockchainNamespace":"tezos","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/companies/details":{"get":{"operationId":"companiesRouter-getCompanyDetailsByWallet","summary":"Get company details by wallet address","description":"Fetch a company customer and its full recursive detail graph (beneficiary companies/individuals, claims, documents, tags and wallets) by one of its associated blockchain wallet addresses, scoped to the workspace resolved from the API key. Read-only. Returns an empty/no-match result when no company in the workspace is linked to the given wallet.","tags":["Company"],"security":[{"Authorization":[]}],"parameters":[{"name":"address","in":"query","required":true,"schema":{"type":"string"},"example":"Alexanderplatz 1, 10178 Berlin, Germany"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"cmsProjectId":{"type":"string"},"workspaceId":{"type":"string","nullable":true},"organizationId":{"type":"string","nullable":true},"externalCustomerId":{"type":"string","nullable":true},"riskScore":{"type":"string","enum":["Low","Medium","High","No risk"],"nullable":true},"type":{"type":"string","enum":["Individual","Company"],"nullable":true},"onboardingLevel":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded","Onboarding","KYB","Onboarded"],"nullable":true},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"reason":{"type":"string","nullable":true},"customerId":{"type":"string","format":"uuid"},"externalId":{"type":"string","nullable":true},"beneficiaryData":{"type":"object","properties":{"id":{"type":"string"},"beneficiaryTypes":{"type":"array","items":{"type":"string","enum":["ubo","shareholder","representative","director"]},"nullable":true},"name":{"type":"string"},"email":{"type":"string"},"beneficiaryPositions":{"type":"array","items":{"anyOf":[{"type":"string","enum":["director","shareholder","other"]},{"type":"string"}]},"nullable":true},"ownershipPercentage":{"type":"number","nullable":true},"inRegistry":{"type":"boolean","nullable":true},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"]},"customerType":{"type":"string","enum":["Individual","Company"]},"belongsTo":{"type":"string","nullable":true}},"required":["id","name","status","customerType"],"additionalProperties":false,"nullable":true},"individualBeneficiaries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"beneficiaryTypes":{"type":"array","items":{"type":"string","enum":["ubo","shareholder","representative","director"]},"nullable":true},"name":{"type":"string"},"email":{"type":"string"},"beneficiaryPositions":{"type":"array","items":{"anyOf":[{"type":"string","enum":["director","shareholder","other"]},{"type":"string"}]},"nullable":true},"ownershipPercentage":{"type":"number","nullable":true},"inRegistry":{"type":"boolean","nullable":true},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"]},"customerType":{"type":"string","enum":["Individual","Company"]},"belongsTo":{"type":"string","nullable":true}},"required":["id","status","customerType"],"additionalProperties":false},"nullable":true},"companyClaims":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"sub":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"registrationNumber":{"type":"string","nullable":true},"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"legalAddress":{"type":"string","nullable":true},"incorporatedOn":{"type":"string","format":"date-time"},"type":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"controlScheme":{"type":"string","nullable":true},"taxId":{"type":"string","nullable":true},"registrationLocation":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"postalAddress":{"type":"string","nullable":true},"updatedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"addresses":{"type":"array","items":{"type":"string"},"nullable":true},"beneficiaries":{"type":"array","items":{"type":"object","properties":{"applicantId":{"type":"string","nullable":true},"type":{"type":"string","enum":["ubo","shareholder","representative","director"],"nullable":true},"inRegistry":{"type":"boolean","nullable":true},"types":{"type":"array","items":{"type":"string","enum":["ubo","shareholder","representative","director"]},"nullable":true},"positions":{"type":"array","items":{"type":"string"},"nullable":true},"imageIds":{"type":"array","items":{"type":"string"},"nullable":true},"shareSize":{"type":"number","nullable":true}},"additionalProperties":false}}},"required":["id","customerId","sub","companyName","registrationNumber","legalAddress","type","email","phone","controlScheme","taxId","registrationLocation","website","postalAddress","updatedAt","createdAt","createdBy","updatedBy","beneficiaries"],"additionalProperties":false},"nullable":true},"documents":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"workflowSessionId":{"type":"string","format":"uuid","nullable":true},"customerId":{"type":"string","format":"uuid"},"documentType":{"type":"string","enum":["id_image_front","id_image_back","selfie_image","proof_of_residence","company_document","video_kyc"]},"metadata":{"anyOf":[{"type":"object","properties":{"sumsubImageId":{"type":"number"},"mediaType":{"type":"string","enum":["image/jpg","image/jpeg","image/png","application/pdf","video/mp4","video/webm","video/quicktime"]},"journeyId":{"type":"string"},"documentType":{"type":"string","enum":["INCORPORATION_CERT","INCORPORATION_ARTICLES","SHAREHOLDER_REGISTRY","INFORMATION_STATEMENT","TRUST_AGREEMENT","STATE_REGISTRY","OFFICERS_REGISTER","BOARD_RESOLUTION"]},"name":{"type":"string"},"entryDate":{"type":"integer"},"entryTime":{"type":"string"},"isSandbox":{"type":"boolean"},"status":{"type":"string","enum":["ACCEPTED","DECLINED","IN_REVIEW"]},"reviewResult":{"type":"object","properties":{"reviewAnswer":{"type":"string","enum":["GREEN","RED","YELLOW"]},"moderationComment":{"type":"string"},"clientComment":{"type":"string"},"rejectLabels":{"type":"array","items":{"type":"string","enum":["FORGERY","DOCUMENT_TEMPLATE","LOW_QUALITY","SPAM","NOT_DOCUMENT","SELFIE_MISMATCH","ID_INVALID","FOREIGNER","DUPLICATE","BAD_AVATAR","WRONG_USER_REGION","INCOMPLETE_DOCUMENT","BLACKLIST","BLOCKLIST","UNSATISFACTORY_PHOTOS","DOCUMENT_PAGE_MISSING","DOCUMENT_DAMAGED","DIGITAL_DOCUMENT","REGULATIONS_VIOLATIONS","INCONSISTENT_PROFILE","PROBLEMATIC_APPLICANT_DATA","ADDITIONAL_DOCUMENT_REQUIRED","AGE_REQUIREMENT_MISMATCH","EXPERIENCE_REQUIREMENT_MISMATCH","CRIMINAL","WRONG_ADDRESS","GRAPHIC_EDITOR","DOCUMENT_DEPRIVED","COMPROMISED_PERSONS","PEP","ADVERSE_MEDIA","FRAUDULENT_PATTERNS","SANCTIONS","NOT_ALL_CHECKS_COMPLETED","FRONT_SIDE_MISSING","BACK_SIDE_MISSING","SCREENSHOTS","BLACK_AND_WHITE","INCOMPATIBLE_LANGUAGE","EXPIRATION_DATE","UNFILLED_ID","BAD_SELFIE","BAD_VIDEO_SELFIE","BAD_FACE_MATCHING","BAD_PROOF_OF_IDENTITY","BAD_PROOF_OF_ADDRESS","BAD_PROOF_OF_PAYMENT","SELFIE_WITH_PAPER","FRAUDULENT_LIVENESS","OTHER","REQUESTED_DATA_MISMATCH","OK","COMPANY_NOT_DEFINED_STRUCTURE","COMPANY_NOT_DEFINED_BENEFICIARIES","COMPANY_NOT_VALIDATED_BENEFICIAL_OWNERS","COMPANY_NOT_VALIDATED_BENEFICIARIES","COMPANY_NOT_VALIDATED_DIRECTORS","COMPANY_NOT_DEFINED_REPRESENTATIVES","COMPANY_NOT_VALIDATED_REPRESENTATIVES","COMPANY_INCORRECT_DATA","UNSUITABLE_DOCUMENT","OUTDATED_DOCUMENT_VERSION","COMPANY_NOT_DEFINED_OWNERSHIP_STRUCTURE","COMPANY_INACTIVE_ENTITY","APPLICANT_INTERRUPTED_INTERVIEW","DOCUMENT_MISSING","UNSUITABLE_ENV","CONNECTION_INTERRUPTED","UNSUPPORTED_LANGUAGE","THIRD_PARTY_INVOLVED","CHECK_UNAVAILABLE","DB_DATA_NOT_FOUND","DB_DATA_MISMATCH","INCORRECT_SOCIAL_NUMBER"]}},"reviewRejectType":{"type":"string","enum":["FINAL","RETRY"]}},"additionalProperties":false,"nullable":true},"deactivated":{"type":"boolean"}},"required":["sumsubImageId","mediaType","journeyId","documentType","entryDate","entryTime","isSandbox"],"additionalProperties":false},{"type":"object","properties":{"source":{"type":"string","enum":["manual_beneficiary_attestation"]},"documentType":{"type":"string","enum":["INCORPORATION_CERT","INCORPORATION_ARTICLES","SHAREHOLDER_REGISTRY","INFORMATION_STATEMENT","TRUST_AGREEMENT","STATE_REGISTRY","OFFICERS_REGISTER","BOARD_RESOLUTION"]},"journeyId":{"type":"string","format":"uuid"},"uploadedBy":{"type":"string"},"mediaType":{"type":"string","enum":["image/jpg","image/jpeg","image/png","application/pdf"]},"name":{"type":"string"}},"required":["source","documentType","journeyId","uploadedBy","mediaType","name"],"additionalProperties":false},{"type":"object","properties":{"journeyId":{"type":"string","format":"uuid","description":"The ID of the journey that this credential is associated with"},"country":{"type":"string","enum":["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"],"description":"The country of residence - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)"},"name":{"type":"string","description":"Name of the document (e.g. ProofOfResidence.jpg)"},"documentType":{"type":"string","enum":["Gas_bill","Internet_bill","Electricity_bill","Rent_agreement","Bank_statement","Not_specified"],"description":"Type of the document (e.g. Gas bill, Internet bill, Electricity bill, Rent agreement, Bank statement)"},"entryDate":{"type":"integer","description":"Entry date associated with the credential"},"entryTime":{"type":"string","description":"Entry time associated with the credential"},"mediaType":{"type":"string","enum":["image/jpeg","image/jpg","image/png","application/pdf"],"description":"Media type of the document (e.g. image/jpeg, image/png, application/pdf)"},"county":{"type":"string","description":"The county of residence"},"city":{"type":"string","description":"The city of residence"},"streetName":{"type":"string","description":"The street name of residence"},"postalCode":{"type":"string","description":"The postal code of residence"},"isSandbox":{"type":"boolean","description":"Indicates if the credential was generated in a sandbox environment"}},"required":["journeyId","documentType","entryDate","entryTime"],"additionalProperties":false,"description":"Stores the data of the credential"},{"type":"object","properties":{"id":{"type":"string"},"journeyId":{"type":"string"},"reviewStatus":{"type":"string"},"roomId":{"type":"string"},"moderatorDisplayName":{"type":"string"}},"required":["id","journeyId","reviewStatus","roomId","moderatorDisplayName"],"additionalProperties":false},{"type":"object","properties":{"credentialId":{"type":"string"},"journeyId":{"type":"string"},"reviewStatus":{"type":"string","enum":["GREEN","RED","YELLOW"]},"verificationMode":{"type":"string","enum":["full_verification","sandbox"],"description":"The verification mode of the project"},"documentType":{"type":"string","enum":["ID_CARD","PASSPORT","DRIVERS","RESIDENCE_PERMIT","UTILITY_BILL","SELFIE","VIDEO_SELFIE","PROFILE_IMAGE","ID_DOC_PHOTO","AGREEMENT","CONTRACT","DRIVERS_TRANSLATION","INVESTOR_DOC","VEHICLE_REGISTRATION_CERTIFICATE","INCOME_SOURCE","PAYMENT_METHOD","BANK_CARD","COVID_VACCINATION_FORM","OTHER"]}},"required":["credentialId","journeyId","reviewStatus","verificationMode","documentType"],"additionalProperties":false},{"type":"object","properties":{"credentialId":{"type":"string"},"journeyId":{"type":"string"},"reviewStatus":{"type":"string","enum":["GREEN","RED","YELLOW"]},"verificationMode":{"type":"string","enum":["full_verification","sandbox"],"description":"The verification mode of the project"}},"required":["credentialId","journeyId","reviewStatus","verificationMode"],"additionalProperties":false}]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"document":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"objectKey":{"type":"string","format":"uuid"},"filename":{"type":"string"},"mimetype":{"type":"string"},"description":{"type":"string","nullable":true},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"presignedUrl":{"type":"string"}},"required":["id","objectKey","filename","mimetype","description","cmsProjectId","organizationId","workspaceId","createdAt","createdBy","presignedUrl"],"additionalProperties":false}},"required":["documentId","customerId","documentType","metadata","createdAt","updatedAt","createdBy","updatedBy","document"],"additionalProperties":false},"nullable":true},"tagsToEntity":{"type":"array","items":{"type":"object","properties":{"id":{},"tagId":{"type":"string"},"entityId":{"type":"string"},"entityType":{"type":"string","enum":["transactionReview","customer","alert","wallet"]},"createdBy":{"type":"string","nullable":true},"tags":{"type":"object","properties":{"id":{},"type":{"type":"string","enum":["transaction","individual","company","wallet"]},"title":{"type":"string"},"backgroundColor":{"type":"string"},"textColor":{"type":"string"},"workspaceId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"deletedAt":{"type":"string","format":"date-time","nullable":true},"createdBy":{"type":"string","nullable":true},"updatedBy":{"type":"string","nullable":true}},"required":["id","type","title","backgroundColor","textColor","workspaceId"],"additionalProperties":false}},"required":["id","tagId","entityId","entityType","tags"],"additionalProperties":false},"nullable":true},"customerWallets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]},"blockchainNamespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"],"nullable":true},"customerId":{"type":"string","format":"uuid"},"verified":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"bigData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid","nullable":true},"wallet":{"type":"string"},"onchainData":{"anyOf":[{"type":"object","properties":{"error":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number","enum":[400]},"errorCode":{"type":"string","enum":["INVALID_ADDRESS"]},"message":{"type":"string","enum":["The address provided isn't a valid address."]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[401]},"errorCode":{"type":"string","enum":["API_KEY_NOT_FOUND"]},"message":{"type":"string","enum":["Your API key is not found."]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[403]},"errorCode":{"type":"string","enum":["API_KEY_ARCHIVED"]},"message":{"type":"string","enum":["Your API key is archived."]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[403]},"errorCode":{"type":"string","enum":["API_KEY_DISABLED"]},"message":{"type":"string","enum":["Your API key is disabled."]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[403]},"errorCode":{"type":"string","enum":["SOURCE_IP_NOT_EQ_API_KEY_IPS"]},"message":{"type":"string","enum":["Your source IP does not match the IPs for your API key."]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[500]},"errorCode":{"type":"string","enum":["INTERNAL_SERVER_ERROR"]},"message":{"type":"string","enum":["INTERNAL SERVER ERROR"]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[500]},"errorCode":{"type":"string","enum":["UNKNOWN_ERROR"]},"message":{"type":"string"}},"required":["statusCode","errorCode","message"],"additionalProperties":false,"description":"This is a fallback error, if bit rank parser fails"},{"type":"object","properties":{"statusCode":{"type":"number","enum":[500]},"errorCode":{"type":"string","enum":["RESULT_PARSER_ERROR"]},"message":{"type":"string"},"data":{"type":"string"}},"required":["statusCode","errorCode","message","data"],"additionalProperties":false,"description":"This is a fallback error, if zod parse fails on result"}]}},"required":["error"],"additionalProperties":false},{"type":"object","properties":{"label":{"type":"string"},"currency":{"type":"string"},"new_address":{"type":"boolean"},"score":{"type":"number"},"entities":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"type":{"type":"string"}},"required":["label","type"],"additionalProperties":false}},"flags":{"type":"array","items":{"type":"string"}},"flags_with_category":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"}},"required":["name","category"],"additionalProperties":false}},"cluster":{"type":"object","properties":{"cluster_name":{"type":"string"},"cluster_identifier":{"type":"number"},"number_of_addresses_in_cluster":{"type":"number"}},"required":["cluster_name","cluster_identifier","number_of_addresses_in_cluster"],"additionalProperties":false},"first_seen_receiving":{"type":"number"},"first_seen_sending":{"type":"number"},"last_seen_receiving":{"type":"number"},"last_seen_sending":{"type":"number"},"received_amount":{"type":"number"},"sent_amount":{"type":"number"},"number_of_transactions":{"type":"number"},"received_transactions":{"type":"number"},"sent_transactions":{"type":"number"},"balance":{"type":"number"},"balance_fiat":{"type":"object","properties":{"jpy":{"type":"number"},"eur":{"type":"number"},"usd":{"type":"number"},"cad":{"type":"number"}},"required":["jpy","eur","usd","cad"],"additionalProperties":false},"bitrank_counterparty_exposure":{"type":"object","properties":{"in":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["min","max","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false},"out":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["min","max","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false}},"required":["in","out"],"additionalProperties":false},"entity_counterparty_exposure":{"type":"object","properties":{"in":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["name","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false},"out":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["name","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false}},"required":["in","out"],"additionalProperties":false},"flag_counterparty_exposure":{"type":"object","properties":{"in":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["name","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false},"out":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["name","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false}},"required":["in","out"],"additionalProperties":false},"transactions":{"type":"array","items":{"type":"object","properties":{"hash":{"type":"string"},"amount":{"type":"number"},"fees":{"type":"number"}},"required":["hash","amount","fees"],"additionalProperties":false}}},"additionalProperties":false}]},"requestObject":{"type":"object","properties":{"crypto":{"type":"string","enum":["btc","eth","ltc","bch","xrp","xlm","sys","xdc","doge","dash","zec","trx","etc","bsc"],"default":"eth","nullable":true},"address":{"type":"string","nullable":true},"properties":{"type":"array","items":{"type":"object","properties":{"property":{"type":"string","enum":["score","entities","flags","currency","new_address","flags_with_category","cluster","first_seen_receiving","first_seen_sending","last_seen_receiving","last_seen_sending","received_amount","sent_amount","number_of_transactions","received_transactions","sent_transactions","balance","balance_fiat","bitrank_counterparty_exposure","entity_counterparty_exposure","flag_counterparty_exposure"]}},"required":["property"],"additionalProperties":false,"description":"A comma-separated list of properties that will determine if the property is in the response."},"description":"Optional query parameter to specify properties to include in the response.","default":[{"property":"score"},{"property":"entities"},{"property":"flags"},{"property":"currency"},{"property":"new_address"}],"nullable":true},"label":{"type":"string","maxLength":255,"description":"Optional string of up to 255 characters for labeling the search.","nullable":true},"transactionsPerPage":{"type":"number","description":"Optional parameter to specify the number of transactions per page in the response.","nullable":true}},"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","wallet","onchainData","requestObject","createdAt","updatedAt"],"additionalProperties":false},"nullable":true},"merkleScienceData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid","nullable":true},"wallet":{"type":"string"},"onchainData":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number","nullable":true},"identifier":{"type":"string","nullable":true},"blockchain":{"type":"integer","minimum":0,"maximum":123,"nullable":true},"blockchain_verbose":{"type":"string","enum":["Bitcoin","Ethereum","Litecoin","BitcoinCash","Ripple","Dogecoin","Zilliqa","BinanceSmartChain","Polygon","Tron","Cardano","Polkadot","Stellar","Hedera","Cronos","Optimism","Arbitrum","Fantom","Monero","Cosmos","Zcash","EthereumClassic","Dash","Solana","AvalancheC_Chain","Verge","BitcoinGold","Algorand","Acala","Akash","Arweave","Ardor","Ark","Astar","Band","BinanceNative","Celo","Chiliz","Nervos","CronosNative","Digibyte","Multiversx","Enjin","Eos","EthereumPow","FetchAI","Filecoin","Flow","Flare","Moonbeam","Helium","ICP","Icon","Injective","IOTA","IoTex","Iris","Kava","Kadena","Klaytn","Komodo","Kusama","Lisk","Terra","Mina","Moonriver","Nano","Near","Neo3","Oasys","One","Ontology","Osmosis","Polymesh","QTUM","Oasis","Thorchain","Ravencoin","Siacoin","Shiden","Songbird","Stratis","Stacks","SUI","zkSync","Theta","Tomo","VeChain","Waves","Wax","WEMIX","WaltonChain","Chia","Tezos","Zcoin","Celestia","Neutron","Avalanche_P","Sei","Avalanche_X","Aztec","Bittensor","Casper","Deso","Juno","PocketNetwork","Ronin","Vara","XPLA","Archway","Axelar","Dymension","Starknet","Orai","Lukso","bitsCrunch","Reef","ImmutablezkEVM","BaseProtocol","ArbitrumNova","Canto","MetisDAO","Aptos","Bitcoin Cash","Binance Smart Chain","Ethereum Classic","Avalanche C-Chain","Bitcoin Gold","Binance Native","Cronos Native","Ethereum Pow","Fetch AI","Avalanche-P","Avalanche-X","Pocket Network","Immutable zkEVM","Base Protocol","Arbitrum Nova"],"nullable":true},"customer_id":{"type":"string","format":"uuid","nullable":true},"type":{"type":"number","nullable":true},"type_verbose":{"type":"string","nullable":true},"total_incoming_value":{"type":"string","nullable":true},"total_incoming_value_usd":{"type":"string","nullable":true},"total_outgoing_value":{"type":"string","nullable":true},"total_outgoing_value_usd":{"type":"string","nullable":true},"balance":{"type":"number","nullable":true},"earliest_transaction_time":{"type":"string","nullable":true},"latest_transaction_time":{"type":"string","nullable":true},"risk_level":{"type":"integer","minimum":0,"maximum":5,"nullable":true},"risk_level_verbose":{"type":"string","enum":["No Risk Detected","Info","Caution","Medium","High","Critical"],"nullable":true},"created_at":{"type":"string","nullable":true},"updated_at":{"type":"string","nullable":true},"originator":{"type":"array","items":{"type":"object","properties":{"tag_type_verbose":{"type":"string"},"tag_subtype_verbose":{"type":"string"},"tag_name_verbose":{"type":"string"},"total_value_usd":{"type":"number"},"exposure_type":{"type":"string"}},"required":["tag_type_verbose","tag_subtype_verbose","tag_name_verbose","total_value_usd","exposure_type"],"additionalProperties":false},"nullable":true},"beneficiary":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":false},"nullable":true},"tags":{"type":"object","properties":{"owner":{"type":"object","properties":{"tag_type_verbose":{"type":"string","nullable":true},"tag_subtype_verbose":{"type":"string","nullable":true},"tag_name_verbose":{"type":"string","nullable":true}},"additionalProperties":false},"user":{"type":"object","properties":{"tag_type_verbose":{"type":"string","nullable":true},"tag_subtype_verbose":{"type":"string","nullable":true},"tag_name_verbose":{"type":"string","nullable":true}},"additionalProperties":false}},"required":["owner","user"],"additionalProperties":false,"nullable":true},"custom_tags":{"type":"array","items":{"type":"string"},"nullable":true},"digital_assets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true},"symbol":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false},{"type":"object","properties":{"error":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"},"data":{"type":"string","nullable":true}},"required":["error","message"],"additionalProperties":false},"risk_level":{"type":"integer","minimum":0,"maximum":5,"nullable":true},"risk_level_verbose":{"type":"string","enum":["No Risk Detected","Info","Caution","Medium","High","Critical"],"nullable":true},"identifier":{"type":"string","nullable":true}},"required":["error"],"additionalProperties":false}]},"requestObject":{"type":"object","properties":{"identifier":{"type":"string"},"blockchain":{"type":"string","enum":["0","1","2","3","4","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31","32","33","34","35","36","37","38","39","40","41","42","43","44","45","46","47","48","49","50","51","52","53","54","55","56","57","58","59","60","61","62","63","64","65","66","67","68","69","70","71","72","73","74","75","76","77","78","79","80","81","82","83","84","85","86","87","88","89","90","91","92","93","94","95","96","97","98","99","100","101","102","103","104","106","107","108","109","110","111","112","113","114","115","116","117","118","119","120","121","122","123"]},"customer_id":{"type":"string","format":"uuid"},"type":{"type":"number","enum":[1,2]},"show_alerts":{"type":"boolean","nullable":true},"custom_tags":{"type":"array","items":{"type":"string"},"nullable":true}},"required":["identifier","blockchain","type"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","wallet","onchainData","requestObject","createdAt","updatedAt"],"additionalProperties":false},"nullable":true},"chainalysisData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"wallet":{"type":"string"},"onchainData":{"anyOf":[{"type":"object","properties":{"address":{"type":"string"},"risk":{"type":"string","enum":["Severe","High","Medium","Low"]},"riskReason":{"type":"string","nullable":true},"cluster":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"}},"required":["name","category"],"additionalProperties":false,"nullable":true},"addressType":{"type":"string","enum":["PRIVATE_WALLET","LIQUIDITY_POOL","SERVICE_PROVIDER"]},"addressIdentifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"url":{"type":"string","nullable":true},"createdAt":{"type":"number"}},"required":["name","address","category","description","createdAt"],"additionalProperties":false}},"exposures":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"value":{"type":"number"},"exposureType":{"type":"string","enum":["direct","indirect"]},"direction":{"type":"string","enum":["both_directions"]}},"required":["category","value","exposureType","direction"],"additionalProperties":false},"nullable":true},"triggers":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"percentage":{"type":"number"},"message":{"type":"string"},"ruleTriggered":{"type":"object","properties":{"risk":{"type":"string"},"minThreshold":{"type":"number"},"maxThreshold":{"type":"number"},"exposureType":{"type":"string","enum":["direct","indirect"]},"direction":{"type":"string","enum":["both_directions"]}},"required":["risk","minThreshold","maxThreshold","exposureType","direction"],"additionalProperties":false,"nullable":true}},"required":["category","percentage","message"],"additionalProperties":false},"nullable":true},"status":{"type":"string","enum":["COMPLETE"]},"poolMetadata":{"type":"object","properties":{"fees":{"type":"number","nullable":true},"tokens":{"type":"array","items":{"type":"string"}}},"required":["tokens"],"additionalProperties":false,"nullable":true}},"required":["address","risk","addressType","addressIdentifications","status"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","nullable":true},"error":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"},"data":{"type":"string","nullable":true}},"required":["error","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}]},"requestObject":{"type":"object","properties":{"address":{"type":"string"}},"required":["address"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","wallet","onchainData","requestObject","createdAt","updatedAt"],"additionalProperties":false},"nullable":true}},"required":["id","wallet","customerId","verified","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"companyBeneficiaries":{"type":"array","items":{}}},"required":["id","cmsProjectId","workspaceId","organizationId","externalCustomerId","riskScore","type","onboardingLevel","status","createdAt","updatedAt","createdBy","updatedBy","customerId","customerWallets","companyBeneficiaries"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","cmsProjectId":"example","workspaceId":"example","organizationId":"example","externalCustomerId":"example","riskScore":"Low","type":"Individual","onboardingLevel":"Started","status":"Active","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","reason":"Manual review required","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","externalId":"example","beneficiaryData":{"id":"example","beneficiaryTypes":["ubo"],"name":"Jane Doe","email":"jane.doe@example.com","beneficiaryPositions":["director"],"ownershipPercentage":42,"inRegistry":true,"status":"Active","customerType":"Individual","belongsTo":"example"},"individualBeneficiaries":[{"id":"example","beneficiaryTypes":["ubo"],"name":"Jane Doe","email":"jane.doe@example.com","beneficiaryPositions":["director"],"ownershipPercentage":42,"inRegistry":true,"status":"Active","customerType":"Individual","belongsTo":"example"}],"companyClaims":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","sub":"example","companyName":"Jane Doe","registrationNumber":"example","country":"AFG","legalAddress":"Alexanderplatz 1, 10178 Berlin, Germany","incorporatedOn":"2024-05-14T09:30:00.000Z","type":"DEFAULT","email":"jane.doe@example.com","phone":"+4915112345678","controlScheme":"example","taxId":"example","registrationLocation":"example","website":"example","postalAddress":"10178","updatedAt":"2024-05-14T09:30:00.000Z","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","addresses":["Alexanderplatz 1, 10178 Berlin, Germany"],"beneficiaries":[{"applicantId":"example","type":"ubo","inRegistry":true,"types":["ubo"],"positions":["example"],"imageIds":["example"],"shareSize":42}]}],"documents":[{"documentId":"3b241101-e2bb-4255-8caf-4136c566a962","workflowSessionId":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","documentType":"id_image_front","metadata":{"sumsubImageId":42,"mediaType":"image/jpg","journeyId":"example","documentType":"INCORPORATION_CERT","name":"Jane Doe","entryDate":42,"entryTime":"example","isSandbox":true,"status":"ACCEPTED","reviewResult":{"reviewAnswer":"GREEN","moderationComment":"Example description","clientComment":"Example description","rejectLabels":["FORGERY"],"reviewRejectType":"FINAL"},"deactivated":true},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","document":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","objectKey":"3b241101-e2bb-4255-8caf-4136c566a962","filename":"Jane Doe","mimetype":"DEFAULT","description":"Example description","cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","presignedUrl":"https://example.com/resource"}}],"tagsToEntity":[{"id":"tte_3b241101e2bb42558caf4136","tagId":"example","entityId":"example","entityType":"transactionReview","createdBy":"workspace","tags":{"id":"tag_3b241101e2bb42558caf4136","type":"transaction","title":"Example title","backgroundColor":"example","textColor":"example","workspaceId":"example","organizationId":"example","deletedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}],"customerWallets":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","blockchainNamespace":"tezos","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","bigData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","onchainData":{"error":{"statusCode":400,"errorCode":"INVALID_ADDRESS","message":"The address provided isn't a valid address."}},"requestObject":{"crypto":"eth","address":"Alexanderplatz 1, 10178 Berlin, Germany","properties":[{"property":"score"},{"property":"entities"},{"property":"flags"},{"property":"currency"},{"property":"new_address"}],"label":"Example label","transactionsPerPage":42},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}],"merkleScienceData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","onchainData":{"statusCode":42,"identifier":"example","blockchain":42,"blockchain_verbose":"Bitcoin","customer_id":"3b241101-e2bb-4255-8caf-4136c566a962","type":42,"type_verbose":"DEFAULT","total_incoming_value":"example","total_incoming_value_usd":"example","total_outgoing_value":"example","total_outgoing_value_usd":"example","balance":42,"earliest_transaction_time":"example","latest_transaction_time":"example","risk_level":5,"risk_level_verbose":"No Risk Detected","created_at":"example","updated_at":"example","originator":[{"tag_type_verbose":"vip","tag_subtype_verbose":"vip","tag_name_verbose":"vip","total_value_usd":42,"exposure_type":"DEFAULT"}],"beneficiary":[{}],"tags":{"owner":{"tag_type_verbose":"vip","tag_subtype_verbose":"vip","tag_name_verbose":"vip"},"user":{"tag_type_verbose":"vip","tag_subtype_verbose":"vip","tag_name_verbose":"vip"}},"custom_tags":["vip"],"digital_assets":[{"name":"Jane Doe","symbol":"example"}]},"requestObject":{"identifier":"example","blockchain":"0","customer_id":"3b241101-e2bb-4255-8caf-4136c566a962","type":1,"show_alerts":true,"custom_tags":["vip"]},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}],"chainalysisData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","onchainData":{"address":"Alexanderplatz 1, 10178 Berlin, Germany","risk":"Severe","riskReason":"Manual review required","cluster":{"name":"Jane Doe","category":"example"},"addressType":"PRIVATE_WALLET","addressIdentifications":[{"name":"Jane Doe","address":"Alexanderplatz 1, 10178 Berlin, Germany","category":"example","description":"Example description","url":"https://example.com/resource","createdAt":42}],"exposures":[{"category":"example","value":42,"exposureType":"direct","direction":"both_directions"}],"triggers":[{"category":"example","percentage":42,"message":"example","ruleTriggered":{"risk":"example","minThreshold":42,"maxThreshold":42,"exposureType":"direct","direction":"both_directions"}}],"status":"COMPLETE","poolMetadata":{"fees":42,"tokens":["tok_example_0001"]}},"requestObject":{"address":"Alexanderplatz 1, 10178 Berlin, Germany"},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}]}],"companyBeneficiaries":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","cmsProjectId":"example","workspaceId":"example","organizationId":"example","externalCustomerId":"example","riskScore":"Low","type":"Individual","onboardingLevel":"Started","status":"Active","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","reason":"Manual review required","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","externalId":"example","beneficiaryData":{"id":"example","beneficiaryTypes":["ubo"],"name":"Jane Doe","email":"jane.doe@example.com","beneficiaryPositions":["director"],"ownershipPercentage":42,"inRegistry":true,"status":"Active","customerType":"Individual","belongsTo":"example"},"individualBeneficiaries":[{"id":"example","beneficiaryTypes":["ubo"],"name":"Jane Doe","email":"jane.doe@example.com","beneficiaryPositions":["director"],"ownershipPercentage":42,"inRegistry":true,"status":"Active","customerType":"Individual","belongsTo":"example"}],"companyClaims":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","sub":"example","companyName":"Jane Doe","registrationNumber":"example","country":"AFG","legalAddress":"Alexanderplatz 1, 10178 Berlin, Germany","incorporatedOn":"2024-05-14T09:30:00.000Z","type":"DEFAULT","email":"jane.doe@example.com","phone":"+4915112345678","controlScheme":"example","taxId":"example","registrationLocation":"example","website":"example","postalAddress":"10178","updatedAt":"2024-05-14T09:30:00.000Z","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","addresses":["Alexanderplatz 1, 10178 Berlin, Germany"],"beneficiaries":[{"applicantId":"example","type":"ubo","inRegistry":true,"types":[],"positions":[],"imageIds":[],"shareSize":42}]}],"documents":[{"documentId":"3b241101-e2bb-4255-8caf-4136c566a962","workflowSessionId":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","documentType":"id_image_front","metadata":{"sumsubImageId":42,"mediaType":"image/jpg","journeyId":"example","documentType":"INCORPORATION_CERT","name":"Jane Doe","entryDate":42,"entryTime":"example","isSandbox":true,"status":"ACCEPTED","reviewResult":{"reviewAnswer":"GREEN","moderationComment":"Example description","clientComment":"Example description","rejectLabels":["FORGERY"],"reviewRejectType":"FINAL"},"deactivated":true},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","document":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","objectKey":"3b241101-e2bb-4255-8caf-4136c566a962","filename":"Jane Doe","mimetype":"DEFAULT","description":"Example description","cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","presignedUrl":"https://example.com/resource"}}],"tagsToEntity":[{"id":"tte_3b241101e2bb42558caf4136","tagId":"example","entityId":"example","entityType":"transactionReview","createdBy":"workspace","tags":{"id":"tag_3b241101e2bb42558caf4136","type":"transaction","title":"Example title","backgroundColor":"example","textColor":"example","workspaceId":"example","organizationId":"example","deletedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}],"customerWallets":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","blockchainNamespace":"tezos","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","bigData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","onchainData":{"error":{"statusCode":400,"errorCode":"INVALID_ADDRESS","message":"The address provided isn't a valid address."}},"requestObject":{"crypto":"eth","address":"Alexanderplatz 1, 10178 Berlin, Germany","properties":[{"property":"score"},{"property":"entities"},{"property":"flags"},{"property":"currency"},{"property":"new_address"}],"label":"Example label","transactionsPerPage":42},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}],"merkleScienceData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","onchainData":{"statusCode":42,"identifier":"example","blockchain":42,"blockchain_verbose":"Bitcoin","customer_id":"3b241101-e2bb-4255-8caf-4136c566a962","type":42,"type_verbose":"DEFAULT","total_incoming_value":"example","total_incoming_value_usd":"example","total_outgoing_value":"example","total_outgoing_value_usd":"example","balance":42,"earliest_transaction_time":"example","latest_transaction_time":"example","risk_level":5,"risk_level_verbose":"No Risk Detected","created_at":"example","updated_at":"example","originator":[],"beneficiary":[],"tags":{"owner":{"tag_type_verbose":"vip","tag_subtype_verbose":"vip","tag_name_verbose":"vip"},"user":{"tag_type_verbose":"vip","tag_subtype_verbose":"vip","tag_name_verbose":"vip"}},"custom_tags":[],"digital_assets":[]},"requestObject":{"identifier":"example","blockchain":"0","customer_id":"3b241101-e2bb-4255-8caf-4136c566a962","type":1,"show_alerts":true,"custom_tags":[]},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}],"chainalysisData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","onchainData":{"address":"Alexanderplatz 1, 10178 Berlin, Germany","risk":"Severe","riskReason":"Manual review required","cluster":{"name":"Jane Doe","category":"example"},"addressType":"PRIVATE_WALLET","addressIdentifications":[],"exposures":[],"triggers":[],"status":"COMPLETE","poolMetadata":{"fees":42,"tokens":[]}},"requestObject":{"address":"Alexanderplatz 1, 10178 Berlin, Germany"},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}]}],"companyBeneficiaries":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","cmsProjectId":"example","workspaceId":"example","organizationId":"example","externalCustomerId":"example","riskScore":"Low","type":"Individual","onboardingLevel":"Started","status":"Active","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","reason":"Manual review required","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","externalId":"example","beneficiaryData":{"id":"example","beneficiaryTypes":["ubo"],"name":"Jane Doe","email":"jane.doe@example.com","beneficiaryPositions":["director"],"ownershipPercentage":42,"inRegistry":true,"status":"Active","customerType":"Individual","belongsTo":"example"},"individualBeneficiaries":[{"id":"example","beneficiaryTypes":[],"name":"Jane Doe","email":"jane.doe@example.com","beneficiaryPositions":[],"ownershipPercentage":42,"inRegistry":true,"status":"Active","customerType":"Individual","belongsTo":"example"}],"companyClaims":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","sub":"example","companyName":"Jane Doe","registrationNumber":"example","country":"AFG","legalAddress":"Alexanderplatz 1, 10178 Berlin, Germany","incorporatedOn":"2024-05-14T09:30:00.000Z","type":"DEFAULT","email":"jane.doe@example.com","phone":"+4915112345678","controlScheme":"example","taxId":"example","registrationLocation":"example","website":"example","postalAddress":"10178","updatedAt":"2024-05-14T09:30:00.000Z","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","addresses":[],"beneficiaries":[]}],"documents":[{"documentId":"3b241101-e2bb-4255-8caf-4136c566a962","workflowSessionId":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","documentType":"id_image_front","metadata":{"sumsubImageId":42,"mediaType":"image/jpg","journeyId":"example","documentType":"INCORPORATION_CERT","name":"Jane Doe","entryDate":42,"entryTime":"example","isSandbox":true,"status":"ACCEPTED","reviewResult":{"reviewAnswer":"GREEN","moderationComment":"Example description","clientComment":"Example description","rejectLabels":[],"reviewRejectType":"FINAL"},"deactivated":true},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","document":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","objectKey":"3b241101-e2bb-4255-8caf-4136c566a962","filename":"Jane Doe","mimetype":"DEFAULT","description":"Example description","cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","presignedUrl":"https://example.com/resource"}}],"tagsToEntity":[{"id":"tte_3b241101e2bb42558caf4136","tagId":"example","entityId":"example","entityType":"transactionReview","createdBy":"workspace","tags":{"id":"tag_3b241101e2bb42558caf4136","type":"transaction","title":"Example title","backgroundColor":"example","textColor":"example","workspaceId":"example","organizationId":"example","deletedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}],"customerWallets":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","blockchainNamespace":"tezos","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","bigData":[],"merkleScienceData":[],"chainalysisData":[]}],"companyBeneficiaries":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","cmsProjectId":"example","workspaceId":"example","organizationId":"example","externalCustomerId":"example","riskScore":"Low","type":"Individual","onboardingLevel":"Started","status":"Active","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","reason":"Manual review required","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","externalId":"example","beneficiaryData":{"id":"example","beneficiaryTypes":[],"name":"Jane Doe","email":"jane.doe@example.com","beneficiaryPositions":[],"ownershipPercentage":42,"inRegistry":true,"status":"Active","customerType":"Individual","belongsTo":"example"},"individualBeneficiaries":[],"companyClaims":[],"documents":[],"tagsToEntity":[],"customerWallets":[],"companyBeneficiaries":[]}]}]}]}}}},"default":{"$ref":"#/components/responses/error"}}}},"/companies/{customerId}":{"get":{"operationId":"companiesRouter-getCompany","summary":"Get company","description":"Fetch a single company customer by its ComPilot customer id (UUID), scoped to the workspace resolved from the API key. Read-only; returns the core company record (external id, onboarding level, audit timestamps). Use `/companies/{customerId}/details` for the full recursive beneficiary/document graph.","tags":["Company"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"workspaceId","in":"query","required":false,"schema":{"type":"string"},"example":"example"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"externalId":{"type":"string"},"onboardingLevel":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded","Onboarding","KYB","Onboarded"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","externalId","onboardingLevel","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","externalId":"example","onboardingLevel":"Started","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}}},"default":{"$ref":"#/components/responses/error"}}},"put":{"operationId":"companiesRouter-updateCompany","summary":"Update company","description":"Update a company.","tags":["Company"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"riskScore":{"type":"string","enum":["Low","Medium","High","No risk"],"nullable":true},"type":{"type":"string","enum":["Individual","Company"],"nullable":true},"onboardingLevel":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded","Onboarding","KYB","Onboarded"],"nullable":true},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"],"nullable":true},"reason":{"type":"string","nullable":true},"externalId":{"type":"string"},"updatedBy":{"type":"string"}},"required":["updatedBy"],"additionalProperties":false},"example":{"riskScore":"Low","type":"Individual","onboardingLevel":"Started","status":"Active","reason":"Manual review required","externalId":"example","updatedBy":"workspace"}}}},"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"externalId":{"type":"string"},"onboardingLevel":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded","Onboarding","KYB","Onboarded"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","externalId","onboardingLevel","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","externalId":"example","onboardingLevel":"Started","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}}},"default":{"$ref":"#/components/responses/error"}}},"delete":{"operationId":"companiesRouter-deleteCompany","summary":"Delete company","description":"Delete a company.","tags":["Company"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"},"example":"example"}}},"default":{"$ref":"#/components/responses/error"}}}},"/companies/{customerId}/details":{"get":{"operationId":"companiesRouter-getCompanyDetail","summary":"Get company details","description":"Fetch a company customer together with its full recursive detail graph (nested beneficiary companies and individuals, claims, documents, entity tags and wallets) by its ComPilot customer id, scoped to the workspace resolved from the API key. Read-only.","tags":["Company"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"workspaceId","in":"query","required":false,"schema":{"type":"string"},"example":"example"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"cmsProjectId":{"type":"string"},"workspaceId":{"type":"string","nullable":true},"organizationId":{"type":"string","nullable":true},"externalCustomerId":{"type":"string","nullable":true},"riskScore":{"type":"string","enum":["Low","Medium","High","No risk"],"nullable":true},"type":{"type":"string","enum":["Individual","Company"],"nullable":true},"onboardingLevel":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded","Onboarding","KYB","Onboarded"],"nullable":true},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"reason":{"type":"string","nullable":true},"customerId":{"type":"string","format":"uuid"},"externalId":{"type":"string","nullable":true},"beneficiaryData":{"type":"object","properties":{"id":{"type":"string"},"beneficiaryTypes":{"type":"array","items":{"type":"string","enum":["ubo","shareholder","representative","director"]},"nullable":true},"name":{"type":"string"},"email":{"type":"string"},"beneficiaryPositions":{"type":"array","items":{"anyOf":[{"type":"string","enum":["director","shareholder","other"]},{"type":"string"}]},"nullable":true},"ownershipPercentage":{"type":"number","nullable":true},"inRegistry":{"type":"boolean","nullable":true},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"]},"customerType":{"type":"string","enum":["Individual","Company"]},"belongsTo":{"type":"string","nullable":true}},"required":["id","name","status","customerType"],"additionalProperties":false,"nullable":true},"individualBeneficiaries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"beneficiaryTypes":{"type":"array","items":{"type":"string","enum":["ubo","shareholder","representative","director"]},"nullable":true},"name":{"type":"string"},"email":{"type":"string"},"beneficiaryPositions":{"type":"array","items":{"anyOf":[{"type":"string","enum":["director","shareholder","other"]},{"type":"string"}]},"nullable":true},"ownershipPercentage":{"type":"number","nullable":true},"inRegistry":{"type":"boolean","nullable":true},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"]},"customerType":{"type":"string","enum":["Individual","Company"]},"belongsTo":{"type":"string","nullable":true}},"required":["id","status","customerType"],"additionalProperties":false},"nullable":true},"companyClaims":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"sub":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"registrationNumber":{"type":"string","nullable":true},"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"legalAddress":{"type":"string","nullable":true},"incorporatedOn":{"type":"string","format":"date-time"},"type":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"controlScheme":{"type":"string","nullable":true},"taxId":{"type":"string","nullable":true},"registrationLocation":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"postalAddress":{"type":"string","nullable":true},"updatedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"addresses":{"type":"array","items":{"type":"string"},"nullable":true},"beneficiaries":{"type":"array","items":{"type":"object","properties":{"applicantId":{"type":"string","nullable":true},"type":{"type":"string","enum":["ubo","shareholder","representative","director"],"nullable":true},"inRegistry":{"type":"boolean","nullable":true},"types":{"type":"array","items":{"type":"string","enum":["ubo","shareholder","representative","director"]},"nullable":true},"positions":{"type":"array","items":{"type":"string"},"nullable":true},"imageIds":{"type":"array","items":{"type":"string"},"nullable":true},"shareSize":{"type":"number","nullable":true}},"additionalProperties":false}}},"required":["id","customerId","sub","companyName","registrationNumber","legalAddress","type","email","phone","controlScheme","taxId","registrationLocation","website","postalAddress","updatedAt","createdAt","createdBy","updatedBy","beneficiaries"],"additionalProperties":false},"nullable":true},"documents":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"workflowSessionId":{"type":"string","format":"uuid","nullable":true},"customerId":{"type":"string","format":"uuid"},"documentType":{"type":"string","enum":["id_image_front","id_image_back","selfie_image","proof_of_residence","company_document","video_kyc"]},"metadata":{"anyOf":[{"type":"object","properties":{"sumsubImageId":{"type":"number"},"mediaType":{"type":"string","enum":["image/jpg","image/jpeg","image/png","application/pdf","video/mp4","video/webm","video/quicktime"]},"journeyId":{"type":"string"},"documentType":{"type":"string","enum":["INCORPORATION_CERT","INCORPORATION_ARTICLES","SHAREHOLDER_REGISTRY","INFORMATION_STATEMENT","TRUST_AGREEMENT","STATE_REGISTRY","OFFICERS_REGISTER","BOARD_RESOLUTION"]},"name":{"type":"string"},"entryDate":{"type":"integer"},"entryTime":{"type":"string"},"isSandbox":{"type":"boolean"},"status":{"type":"string","enum":["ACCEPTED","DECLINED","IN_REVIEW"]},"reviewResult":{"type":"object","properties":{"reviewAnswer":{"type":"string","enum":["GREEN","RED","YELLOW"]},"moderationComment":{"type":"string"},"clientComment":{"type":"string"},"rejectLabels":{"type":"array","items":{"type":"string","enum":["FORGERY","DOCUMENT_TEMPLATE","LOW_QUALITY","SPAM","NOT_DOCUMENT","SELFIE_MISMATCH","ID_INVALID","FOREIGNER","DUPLICATE","BAD_AVATAR","WRONG_USER_REGION","INCOMPLETE_DOCUMENT","BLACKLIST","BLOCKLIST","UNSATISFACTORY_PHOTOS","DOCUMENT_PAGE_MISSING","DOCUMENT_DAMAGED","DIGITAL_DOCUMENT","REGULATIONS_VIOLATIONS","INCONSISTENT_PROFILE","PROBLEMATIC_APPLICANT_DATA","ADDITIONAL_DOCUMENT_REQUIRED","AGE_REQUIREMENT_MISMATCH","EXPERIENCE_REQUIREMENT_MISMATCH","CRIMINAL","WRONG_ADDRESS","GRAPHIC_EDITOR","DOCUMENT_DEPRIVED","COMPROMISED_PERSONS","PEP","ADVERSE_MEDIA","FRAUDULENT_PATTERNS","SANCTIONS","NOT_ALL_CHECKS_COMPLETED","FRONT_SIDE_MISSING","BACK_SIDE_MISSING","SCREENSHOTS","BLACK_AND_WHITE","INCOMPATIBLE_LANGUAGE","EXPIRATION_DATE","UNFILLED_ID","BAD_SELFIE","BAD_VIDEO_SELFIE","BAD_FACE_MATCHING","BAD_PROOF_OF_IDENTITY","BAD_PROOF_OF_ADDRESS","BAD_PROOF_OF_PAYMENT","SELFIE_WITH_PAPER","FRAUDULENT_LIVENESS","OTHER","REQUESTED_DATA_MISMATCH","OK","COMPANY_NOT_DEFINED_STRUCTURE","COMPANY_NOT_DEFINED_BENEFICIARIES","COMPANY_NOT_VALIDATED_BENEFICIAL_OWNERS","COMPANY_NOT_VALIDATED_BENEFICIARIES","COMPANY_NOT_VALIDATED_DIRECTORS","COMPANY_NOT_DEFINED_REPRESENTATIVES","COMPANY_NOT_VALIDATED_REPRESENTATIVES","COMPANY_INCORRECT_DATA","UNSUITABLE_DOCUMENT","OUTDATED_DOCUMENT_VERSION","COMPANY_NOT_DEFINED_OWNERSHIP_STRUCTURE","COMPANY_INACTIVE_ENTITY","APPLICANT_INTERRUPTED_INTERVIEW","DOCUMENT_MISSING","UNSUITABLE_ENV","CONNECTION_INTERRUPTED","UNSUPPORTED_LANGUAGE","THIRD_PARTY_INVOLVED","CHECK_UNAVAILABLE","DB_DATA_NOT_FOUND","DB_DATA_MISMATCH","INCORRECT_SOCIAL_NUMBER"]}},"reviewRejectType":{"type":"string","enum":["FINAL","RETRY"]}},"additionalProperties":false,"nullable":true},"deactivated":{"type":"boolean"}},"required":["sumsubImageId","mediaType","journeyId","documentType","entryDate","entryTime","isSandbox"],"additionalProperties":false},{"type":"object","properties":{"source":{"type":"string","enum":["manual_beneficiary_attestation"]},"documentType":{"type":"string","enum":["INCORPORATION_CERT","INCORPORATION_ARTICLES","SHAREHOLDER_REGISTRY","INFORMATION_STATEMENT","TRUST_AGREEMENT","STATE_REGISTRY","OFFICERS_REGISTER","BOARD_RESOLUTION"]},"journeyId":{"type":"string","format":"uuid"},"uploadedBy":{"type":"string"},"mediaType":{"type":"string","enum":["image/jpg","image/jpeg","image/png","application/pdf"]},"name":{"type":"string"}},"required":["source","documentType","journeyId","uploadedBy","mediaType","name"],"additionalProperties":false},{"type":"object","properties":{"journeyId":{"type":"string","format":"uuid","description":"The ID of the journey that this credential is associated with"},"country":{"type":"string","enum":["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"],"description":"The country of residence - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)"},"name":{"type":"string","description":"Name of the document (e.g. ProofOfResidence.jpg)"},"documentType":{"type":"string","enum":["Gas_bill","Internet_bill","Electricity_bill","Rent_agreement","Bank_statement","Not_specified"],"description":"Type of the document (e.g. Gas bill, Internet bill, Electricity bill, Rent agreement, Bank statement)"},"entryDate":{"type":"integer","description":"Entry date associated with the credential"},"entryTime":{"type":"string","description":"Entry time associated with the credential"},"mediaType":{"type":"string","enum":["image/jpeg","image/jpg","image/png","application/pdf"],"description":"Media type of the document (e.g. image/jpeg, image/png, application/pdf)"},"county":{"type":"string","description":"The county of residence"},"city":{"type":"string","description":"The city of residence"},"streetName":{"type":"string","description":"The street name of residence"},"postalCode":{"type":"string","description":"The postal code of residence"},"isSandbox":{"type":"boolean","description":"Indicates if the credential was generated in a sandbox environment"}},"required":["journeyId","documentType","entryDate","entryTime"],"additionalProperties":false,"description":"Stores the data of the credential"},{"type":"object","properties":{"id":{"type":"string"},"journeyId":{"type":"string"},"reviewStatus":{"type":"string"},"roomId":{"type":"string"},"moderatorDisplayName":{"type":"string"}},"required":["id","journeyId","reviewStatus","roomId","moderatorDisplayName"],"additionalProperties":false},{"type":"object","properties":{"credentialId":{"type":"string"},"journeyId":{"type":"string"},"reviewStatus":{"type":"string","enum":["GREEN","RED","YELLOW"]},"verificationMode":{"type":"string","enum":["full_verification","sandbox"],"description":"The verification mode of the project"},"documentType":{"type":"string","enum":["ID_CARD","PASSPORT","DRIVERS","RESIDENCE_PERMIT","UTILITY_BILL","SELFIE","VIDEO_SELFIE","PROFILE_IMAGE","ID_DOC_PHOTO","AGREEMENT","CONTRACT","DRIVERS_TRANSLATION","INVESTOR_DOC","VEHICLE_REGISTRATION_CERTIFICATE","INCOME_SOURCE","PAYMENT_METHOD","BANK_CARD","COVID_VACCINATION_FORM","OTHER"]}},"required":["credentialId","journeyId","reviewStatus","verificationMode","documentType"],"additionalProperties":false},{"type":"object","properties":{"credentialId":{"type":"string"},"journeyId":{"type":"string"},"reviewStatus":{"type":"string","enum":["GREEN","RED","YELLOW"]},"verificationMode":{"type":"string","enum":["full_verification","sandbox"],"description":"The verification mode of the project"}},"required":["credentialId","journeyId","reviewStatus","verificationMode"],"additionalProperties":false}]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"document":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"objectKey":{"type":"string","format":"uuid"},"filename":{"type":"string"},"mimetype":{"type":"string"},"description":{"type":"string","nullable":true},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"presignedUrl":{"type":"string"}},"required":["id","objectKey","filename","mimetype","description","cmsProjectId","organizationId","workspaceId","createdAt","createdBy","presignedUrl"],"additionalProperties":false}},"required":["documentId","customerId","documentType","metadata","createdAt","updatedAt","createdBy","updatedBy","document"],"additionalProperties":false},"nullable":true},"tagsToEntity":{"type":"array","items":{"type":"object","properties":{"id":{},"tagId":{"type":"string"},"entityId":{"type":"string"},"entityType":{"type":"string","enum":["transactionReview","customer","alert","wallet"]},"createdBy":{"type":"string","nullable":true},"tags":{"type":"object","properties":{"id":{},"type":{"type":"string","enum":["transaction","individual","company","wallet"]},"title":{"type":"string"},"backgroundColor":{"type":"string"},"textColor":{"type":"string"},"workspaceId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"deletedAt":{"type":"string","format":"date-time","nullable":true},"createdBy":{"type":"string","nullable":true},"updatedBy":{"type":"string","nullable":true}},"required":["id","type","title","backgroundColor","textColor","workspaceId"],"additionalProperties":false}},"required":["id","tagId","entityId","entityType","tags"],"additionalProperties":false},"nullable":true},"customerWallets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]},"blockchainNamespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"],"nullable":true},"customerId":{"type":"string","format":"uuid"},"verified":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"bigData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid","nullable":true},"wallet":{"type":"string"},"onchainData":{"anyOf":[{"type":"object","properties":{"error":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number","enum":[400]},"errorCode":{"type":"string","enum":["INVALID_ADDRESS"]},"message":{"type":"string","enum":["The address provided isn't a valid address."]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[401]},"errorCode":{"type":"string","enum":["API_KEY_NOT_FOUND"]},"message":{"type":"string","enum":["Your API key is not found."]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[403]},"errorCode":{"type":"string","enum":["API_KEY_ARCHIVED"]},"message":{"type":"string","enum":["Your API key is archived."]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[403]},"errorCode":{"type":"string","enum":["API_KEY_DISABLED"]},"message":{"type":"string","enum":["Your API key is disabled."]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[403]},"errorCode":{"type":"string","enum":["SOURCE_IP_NOT_EQ_API_KEY_IPS"]},"message":{"type":"string","enum":["Your source IP does not match the IPs for your API key."]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[500]},"errorCode":{"type":"string","enum":["INTERNAL_SERVER_ERROR"]},"message":{"type":"string","enum":["INTERNAL SERVER ERROR"]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[500]},"errorCode":{"type":"string","enum":["UNKNOWN_ERROR"]},"message":{"type":"string"}},"required":["statusCode","errorCode","message"],"additionalProperties":false,"description":"This is a fallback error, if bit rank parser fails"},{"type":"object","properties":{"statusCode":{"type":"number","enum":[500]},"errorCode":{"type":"string","enum":["RESULT_PARSER_ERROR"]},"message":{"type":"string"},"data":{"type":"string"}},"required":["statusCode","errorCode","message","data"],"additionalProperties":false,"description":"This is a fallback error, if zod parse fails on result"}]}},"required":["error"],"additionalProperties":false},{"type":"object","properties":{"label":{"type":"string"},"currency":{"type":"string"},"new_address":{"type":"boolean"},"score":{"type":"number"},"entities":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"type":{"type":"string"}},"required":["label","type"],"additionalProperties":false}},"flags":{"type":"array","items":{"type":"string"}},"flags_with_category":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"}},"required":["name","category"],"additionalProperties":false}},"cluster":{"type":"object","properties":{"cluster_name":{"type":"string"},"cluster_identifier":{"type":"number"},"number_of_addresses_in_cluster":{"type":"number"}},"required":["cluster_name","cluster_identifier","number_of_addresses_in_cluster"],"additionalProperties":false},"first_seen_receiving":{"type":"number"},"first_seen_sending":{"type":"number"},"last_seen_receiving":{"type":"number"},"last_seen_sending":{"type":"number"},"received_amount":{"type":"number"},"sent_amount":{"type":"number"},"number_of_transactions":{"type":"number"},"received_transactions":{"type":"number"},"sent_transactions":{"type":"number"},"balance":{"type":"number"},"balance_fiat":{"type":"object","properties":{"jpy":{"type":"number"},"eur":{"type":"number"},"usd":{"type":"number"},"cad":{"type":"number"}},"required":["jpy","eur","usd","cad"],"additionalProperties":false},"bitrank_counterparty_exposure":{"type":"object","properties":{"in":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["min","max","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false},"out":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["min","max","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false}},"required":["in","out"],"additionalProperties":false},"entity_counterparty_exposure":{"type":"object","properties":{"in":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["name","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false},"out":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["name","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false}},"required":["in","out"],"additionalProperties":false},"flag_counterparty_exposure":{"type":"object","properties":{"in":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["name","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false},"out":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["name","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false}},"required":["in","out"],"additionalProperties":false},"transactions":{"type":"array","items":{"type":"object","properties":{"hash":{"type":"string"},"amount":{"type":"number"},"fees":{"type":"number"}},"required":["hash","amount","fees"],"additionalProperties":false}}},"additionalProperties":false}]},"requestObject":{"type":"object","properties":{"crypto":{"type":"string","enum":["btc","eth","ltc","bch","xrp","xlm","sys","xdc","doge","dash","zec","trx","etc","bsc"],"default":"eth","nullable":true},"address":{"type":"string","nullable":true},"properties":{"type":"array","items":{"type":"object","properties":{"property":{"type":"string","enum":["score","entities","flags","currency","new_address","flags_with_category","cluster","first_seen_receiving","first_seen_sending","last_seen_receiving","last_seen_sending","received_amount","sent_amount","number_of_transactions","received_transactions","sent_transactions","balance","balance_fiat","bitrank_counterparty_exposure","entity_counterparty_exposure","flag_counterparty_exposure"]}},"required":["property"],"additionalProperties":false,"description":"A comma-separated list of properties that will determine if the property is in the response."},"description":"Optional query parameter to specify properties to include in the response.","default":[{"property":"score"},{"property":"entities"},{"property":"flags"},{"property":"currency"},{"property":"new_address"}],"nullable":true},"label":{"type":"string","maxLength":255,"description":"Optional string of up to 255 characters for labeling the search.","nullable":true},"transactionsPerPage":{"type":"number","description":"Optional parameter to specify the number of transactions per page in the response.","nullable":true}},"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","wallet","onchainData","requestObject","createdAt","updatedAt"],"additionalProperties":false},"nullable":true},"merkleScienceData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid","nullable":true},"wallet":{"type":"string"},"onchainData":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number","nullable":true},"identifier":{"type":"string","nullable":true},"blockchain":{"type":"integer","minimum":0,"maximum":123,"nullable":true},"blockchain_verbose":{"type":"string","enum":["Bitcoin","Ethereum","Litecoin","BitcoinCash","Ripple","Dogecoin","Zilliqa","BinanceSmartChain","Polygon","Tron","Cardano","Polkadot","Stellar","Hedera","Cronos","Optimism","Arbitrum","Fantom","Monero","Cosmos","Zcash","EthereumClassic","Dash","Solana","AvalancheC_Chain","Verge","BitcoinGold","Algorand","Acala","Akash","Arweave","Ardor","Ark","Astar","Band","BinanceNative","Celo","Chiliz","Nervos","CronosNative","Digibyte","Multiversx","Enjin","Eos","EthereumPow","FetchAI","Filecoin","Flow","Flare","Moonbeam","Helium","ICP","Icon","Injective","IOTA","IoTex","Iris","Kava","Kadena","Klaytn","Komodo","Kusama","Lisk","Terra","Mina","Moonriver","Nano","Near","Neo3","Oasys","One","Ontology","Osmosis","Polymesh","QTUM","Oasis","Thorchain","Ravencoin","Siacoin","Shiden","Songbird","Stratis","Stacks","SUI","zkSync","Theta","Tomo","VeChain","Waves","Wax","WEMIX","WaltonChain","Chia","Tezos","Zcoin","Celestia","Neutron","Avalanche_P","Sei","Avalanche_X","Aztec","Bittensor","Casper","Deso","Juno","PocketNetwork","Ronin","Vara","XPLA","Archway","Axelar","Dymension","Starknet","Orai","Lukso","bitsCrunch","Reef","ImmutablezkEVM","BaseProtocol","ArbitrumNova","Canto","MetisDAO","Aptos","Bitcoin Cash","Binance Smart Chain","Ethereum Classic","Avalanche C-Chain","Bitcoin Gold","Binance Native","Cronos Native","Ethereum Pow","Fetch AI","Avalanche-P","Avalanche-X","Pocket Network","Immutable zkEVM","Base Protocol","Arbitrum Nova"],"nullable":true},"customer_id":{"type":"string","format":"uuid","nullable":true},"type":{"type":"number","nullable":true},"type_verbose":{"type":"string","nullable":true},"total_incoming_value":{"type":"string","nullable":true},"total_incoming_value_usd":{"type":"string","nullable":true},"total_outgoing_value":{"type":"string","nullable":true},"total_outgoing_value_usd":{"type":"string","nullable":true},"balance":{"type":"number","nullable":true},"earliest_transaction_time":{"type":"string","nullable":true},"latest_transaction_time":{"type":"string","nullable":true},"risk_level":{"type":"integer","minimum":0,"maximum":5,"nullable":true},"risk_level_verbose":{"type":"string","enum":["No Risk Detected","Info","Caution","Medium","High","Critical"],"nullable":true},"created_at":{"type":"string","nullable":true},"updated_at":{"type":"string","nullable":true},"originator":{"type":"array","items":{"type":"object","properties":{"tag_type_verbose":{"type":"string"},"tag_subtype_verbose":{"type":"string"},"tag_name_verbose":{"type":"string"},"total_value_usd":{"type":"number"},"exposure_type":{"type":"string"}},"required":["tag_type_verbose","tag_subtype_verbose","tag_name_verbose","total_value_usd","exposure_type"],"additionalProperties":false},"nullable":true},"beneficiary":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":false},"nullable":true},"tags":{"type":"object","properties":{"owner":{"type":"object","properties":{"tag_type_verbose":{"type":"string","nullable":true},"tag_subtype_verbose":{"type":"string","nullable":true},"tag_name_verbose":{"type":"string","nullable":true}},"additionalProperties":false},"user":{"type":"object","properties":{"tag_type_verbose":{"type":"string","nullable":true},"tag_subtype_verbose":{"type":"string","nullable":true},"tag_name_verbose":{"type":"string","nullable":true}},"additionalProperties":false}},"required":["owner","user"],"additionalProperties":false,"nullable":true},"custom_tags":{"type":"array","items":{"type":"string"},"nullable":true},"digital_assets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true},"symbol":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false},{"type":"object","properties":{"error":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"},"data":{"type":"string","nullable":true}},"required":["error","message"],"additionalProperties":false},"risk_level":{"type":"integer","minimum":0,"maximum":5,"nullable":true},"risk_level_verbose":{"type":"string","enum":["No Risk Detected","Info","Caution","Medium","High","Critical"],"nullable":true},"identifier":{"type":"string","nullable":true}},"required":["error"],"additionalProperties":false}]},"requestObject":{"type":"object","properties":{"identifier":{"type":"string"},"blockchain":{"type":"string","enum":["0","1","2","3","4","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31","32","33","34","35","36","37","38","39","40","41","42","43","44","45","46","47","48","49","50","51","52","53","54","55","56","57","58","59","60","61","62","63","64","65","66","67","68","69","70","71","72","73","74","75","76","77","78","79","80","81","82","83","84","85","86","87","88","89","90","91","92","93","94","95","96","97","98","99","100","101","102","103","104","106","107","108","109","110","111","112","113","114","115","116","117","118","119","120","121","122","123"]},"customer_id":{"type":"string","format":"uuid"},"type":{"type":"number","enum":[1,2]},"show_alerts":{"type":"boolean","nullable":true},"custom_tags":{"type":"array","items":{"type":"string"},"nullable":true}},"required":["identifier","blockchain","type"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","wallet","onchainData","requestObject","createdAt","updatedAt"],"additionalProperties":false},"nullable":true},"chainalysisData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"wallet":{"type":"string"},"onchainData":{"anyOf":[{"type":"object","properties":{"address":{"type":"string"},"risk":{"type":"string","enum":["Severe","High","Medium","Low"]},"riskReason":{"type":"string","nullable":true},"cluster":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"}},"required":["name","category"],"additionalProperties":false,"nullable":true},"addressType":{"type":"string","enum":["PRIVATE_WALLET","LIQUIDITY_POOL","SERVICE_PROVIDER"]},"addressIdentifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"url":{"type":"string","nullable":true},"createdAt":{"type":"number"}},"required":["name","address","category","description","createdAt"],"additionalProperties":false}},"exposures":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"value":{"type":"number"},"exposureType":{"type":"string","enum":["direct","indirect"]},"direction":{"type":"string","enum":["both_directions"]}},"required":["category","value","exposureType","direction"],"additionalProperties":false},"nullable":true},"triggers":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"percentage":{"type":"number"},"message":{"type":"string"},"ruleTriggered":{"type":"object","properties":{"risk":{"type":"string"},"minThreshold":{"type":"number"},"maxThreshold":{"type":"number"},"exposureType":{"type":"string","enum":["direct","indirect"]},"direction":{"type":"string","enum":["both_directions"]}},"required":["risk","minThreshold","maxThreshold","exposureType","direction"],"additionalProperties":false,"nullable":true}},"required":["category","percentage","message"],"additionalProperties":false},"nullable":true},"status":{"type":"string","enum":["COMPLETE"]},"poolMetadata":{"type":"object","properties":{"fees":{"type":"number","nullable":true},"tokens":{"type":"array","items":{"type":"string"}}},"required":["tokens"],"additionalProperties":false,"nullable":true}},"required":["address","risk","addressType","addressIdentifications","status"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","nullable":true},"error":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"},"data":{"type":"string","nullable":true}},"required":["error","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}]},"requestObject":{"type":"object","properties":{"address":{"type":"string"}},"required":["address"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","wallet","onchainData","requestObject","createdAt","updatedAt"],"additionalProperties":false},"nullable":true}},"required":["id","wallet","customerId","verified","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"companyBeneficiaries":{"type":"array","items":{}}},"required":["id","cmsProjectId","workspaceId","organizationId","externalCustomerId","riskScore","type","onboardingLevel","status","createdAt","updatedAt","createdBy","updatedBy","customerId","customerWallets","companyBeneficiaries"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","cmsProjectId":"example","workspaceId":"example","organizationId":"example","externalCustomerId":"example","riskScore":"Low","type":"Individual","onboardingLevel":"Started","status":"Active","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","reason":"Manual review required","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","externalId":"example","beneficiaryData":{"id":"example","beneficiaryTypes":["ubo"],"name":"Jane Doe","email":"jane.doe@example.com","beneficiaryPositions":["director"],"ownershipPercentage":42,"inRegistry":true,"status":"Active","customerType":"Individual","belongsTo":"example"},"individualBeneficiaries":[{"id":"example","beneficiaryTypes":["ubo"],"name":"Jane Doe","email":"jane.doe@example.com","beneficiaryPositions":["director"],"ownershipPercentage":42,"inRegistry":true,"status":"Active","customerType":"Individual","belongsTo":"example"}],"companyClaims":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","sub":"example","companyName":"Jane Doe","registrationNumber":"example","country":"AFG","legalAddress":"Alexanderplatz 1, 10178 Berlin, Germany","incorporatedOn":"2024-05-14T09:30:00.000Z","type":"DEFAULT","email":"jane.doe@example.com","phone":"+4915112345678","controlScheme":"example","taxId":"example","registrationLocation":"example","website":"example","postalAddress":"10178","updatedAt":"2024-05-14T09:30:00.000Z","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","addresses":["Alexanderplatz 1, 10178 Berlin, Germany"],"beneficiaries":[{"applicantId":"example","type":"ubo","inRegistry":true,"types":["ubo"],"positions":["example"],"imageIds":["example"],"shareSize":42}]}],"documents":[{"documentId":"3b241101-e2bb-4255-8caf-4136c566a962","workflowSessionId":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","documentType":"id_image_front","metadata":{"sumsubImageId":42,"mediaType":"image/jpg","journeyId":"example","documentType":"INCORPORATION_CERT","name":"Jane Doe","entryDate":42,"entryTime":"example","isSandbox":true,"status":"ACCEPTED","reviewResult":{"reviewAnswer":"GREEN","moderationComment":"Example description","clientComment":"Example description","rejectLabels":["FORGERY"],"reviewRejectType":"FINAL"},"deactivated":true},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","document":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","objectKey":"3b241101-e2bb-4255-8caf-4136c566a962","filename":"Jane Doe","mimetype":"DEFAULT","description":"Example description","cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","presignedUrl":"https://example.com/resource"}}],"tagsToEntity":[{"id":"tte_3b241101e2bb42558caf4136","tagId":"example","entityId":"example","entityType":"transactionReview","createdBy":"workspace","tags":{"id":"tag_3b241101e2bb42558caf4136","type":"transaction","title":"Example title","backgroundColor":"example","textColor":"example","workspaceId":"example","organizationId":"example","deletedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}],"customerWallets":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","blockchainNamespace":"tezos","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","bigData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","onchainData":{"error":{"statusCode":400,"errorCode":"INVALID_ADDRESS","message":"The address provided isn't a valid address."}},"requestObject":{"crypto":"eth","address":"Alexanderplatz 1, 10178 Berlin, Germany","properties":[{"property":"score"},{"property":"entities"},{"property":"flags"},{"property":"currency"},{"property":"new_address"}],"label":"Example label","transactionsPerPage":42},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}],"merkleScienceData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","onchainData":{"statusCode":42,"identifier":"example","blockchain":42,"blockchain_verbose":"Bitcoin","customer_id":"3b241101-e2bb-4255-8caf-4136c566a962","type":42,"type_verbose":"DEFAULT","total_incoming_value":"example","total_incoming_value_usd":"example","total_outgoing_value":"example","total_outgoing_value_usd":"example","balance":42,"earliest_transaction_time":"example","latest_transaction_time":"example","risk_level":5,"risk_level_verbose":"No Risk Detected","created_at":"example","updated_at":"example","originator":[{"tag_type_verbose":"vip","tag_subtype_verbose":"vip","tag_name_verbose":"vip","total_value_usd":42,"exposure_type":"DEFAULT"}],"beneficiary":[{}],"tags":{"owner":{"tag_type_verbose":"vip","tag_subtype_verbose":"vip","tag_name_verbose":"vip"},"user":{"tag_type_verbose":"vip","tag_subtype_verbose":"vip","tag_name_verbose":"vip"}},"custom_tags":["vip"],"digital_assets":[{"name":"Jane Doe","symbol":"example"}]},"requestObject":{"identifier":"example","blockchain":"0","customer_id":"3b241101-e2bb-4255-8caf-4136c566a962","type":1,"show_alerts":true,"custom_tags":["vip"]},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}],"chainalysisData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","onchainData":{"address":"Alexanderplatz 1, 10178 Berlin, Germany","risk":"Severe","riskReason":"Manual review required","cluster":{"name":"Jane Doe","category":"example"},"addressType":"PRIVATE_WALLET","addressIdentifications":[{"name":"Jane Doe","address":"Alexanderplatz 1, 10178 Berlin, Germany","category":"example","description":"Example description","url":"https://example.com/resource","createdAt":42}],"exposures":[{"category":"example","value":42,"exposureType":"direct","direction":"both_directions"}],"triggers":[{"category":"example","percentage":42,"message":"example","ruleTriggered":{"risk":"example","minThreshold":42,"maxThreshold":42,"exposureType":"direct","direction":"both_directions"}}],"status":"COMPLETE","poolMetadata":{"fees":42,"tokens":["tok_example_0001"]}},"requestObject":{"address":"Alexanderplatz 1, 10178 Berlin, Germany"},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}]}],"companyBeneficiaries":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","cmsProjectId":"example","workspaceId":"example","organizationId":"example","externalCustomerId":"example","riskScore":"Low","type":"Individual","onboardingLevel":"Started","status":"Active","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","reason":"Manual review required","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","externalId":"example","beneficiaryData":{"id":"example","beneficiaryTypes":["ubo"],"name":"Jane Doe","email":"jane.doe@example.com","beneficiaryPositions":["director"],"ownershipPercentage":42,"inRegistry":true,"status":"Active","customerType":"Individual","belongsTo":"example"},"individualBeneficiaries":[{"id":"example","beneficiaryTypes":["ubo"],"name":"Jane Doe","email":"jane.doe@example.com","beneficiaryPositions":["director"],"ownershipPercentage":42,"inRegistry":true,"status":"Active","customerType":"Individual","belongsTo":"example"}],"companyClaims":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","sub":"example","companyName":"Jane Doe","registrationNumber":"example","country":"AFG","legalAddress":"Alexanderplatz 1, 10178 Berlin, Germany","incorporatedOn":"2024-05-14T09:30:00.000Z","type":"DEFAULT","email":"jane.doe@example.com","phone":"+4915112345678","controlScheme":"example","taxId":"example","registrationLocation":"example","website":"example","postalAddress":"10178","updatedAt":"2024-05-14T09:30:00.000Z","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","addresses":["Alexanderplatz 1, 10178 Berlin, Germany"],"beneficiaries":[{"applicantId":"example","type":"ubo","inRegistry":true,"types":[],"positions":[],"imageIds":[],"shareSize":42}]}],"documents":[{"documentId":"3b241101-e2bb-4255-8caf-4136c566a962","workflowSessionId":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","documentType":"id_image_front","metadata":{"sumsubImageId":42,"mediaType":"image/jpg","journeyId":"example","documentType":"INCORPORATION_CERT","name":"Jane Doe","entryDate":42,"entryTime":"example","isSandbox":true,"status":"ACCEPTED","reviewResult":{"reviewAnswer":"GREEN","moderationComment":"Example description","clientComment":"Example description","rejectLabels":["FORGERY"],"reviewRejectType":"FINAL"},"deactivated":true},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","document":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","objectKey":"3b241101-e2bb-4255-8caf-4136c566a962","filename":"Jane Doe","mimetype":"DEFAULT","description":"Example description","cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","presignedUrl":"https://example.com/resource"}}],"tagsToEntity":[{"id":"tte_3b241101e2bb42558caf4136","tagId":"example","entityId":"example","entityType":"transactionReview","createdBy":"workspace","tags":{"id":"tag_3b241101e2bb42558caf4136","type":"transaction","title":"Example title","backgroundColor":"example","textColor":"example","workspaceId":"example","organizationId":"example","deletedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}],"customerWallets":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","blockchainNamespace":"tezos","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","bigData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","onchainData":{"error":{"statusCode":400,"errorCode":"INVALID_ADDRESS","message":"The address provided isn't a valid address."}},"requestObject":{"crypto":"eth","address":"Alexanderplatz 1, 10178 Berlin, Germany","properties":[{"property":"score"},{"property":"entities"},{"property":"flags"},{"property":"currency"},{"property":"new_address"}],"label":"Example label","transactionsPerPage":42},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}],"merkleScienceData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","onchainData":{"statusCode":42,"identifier":"example","blockchain":42,"blockchain_verbose":"Bitcoin","customer_id":"3b241101-e2bb-4255-8caf-4136c566a962","type":42,"type_verbose":"DEFAULT","total_incoming_value":"example","total_incoming_value_usd":"example","total_outgoing_value":"example","total_outgoing_value_usd":"example","balance":42,"earliest_transaction_time":"example","latest_transaction_time":"example","risk_level":5,"risk_level_verbose":"No Risk Detected","created_at":"example","updated_at":"example","originator":[],"beneficiary":[],"tags":{"owner":{"tag_type_verbose":"vip","tag_subtype_verbose":"vip","tag_name_verbose":"vip"},"user":{"tag_type_verbose":"vip","tag_subtype_verbose":"vip","tag_name_verbose":"vip"}},"custom_tags":[],"digital_assets":[]},"requestObject":{"identifier":"example","blockchain":"0","customer_id":"3b241101-e2bb-4255-8caf-4136c566a962","type":1,"show_alerts":true,"custom_tags":[]},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}],"chainalysisData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","onchainData":{"address":"Alexanderplatz 1, 10178 Berlin, Germany","risk":"Severe","riskReason":"Manual review required","cluster":{"name":"Jane Doe","category":"example"},"addressType":"PRIVATE_WALLET","addressIdentifications":[],"exposures":[],"triggers":[],"status":"COMPLETE","poolMetadata":{"fees":42,"tokens":[]}},"requestObject":{"address":"Alexanderplatz 1, 10178 Berlin, Germany"},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}]}],"companyBeneficiaries":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","cmsProjectId":"example","workspaceId":"example","organizationId":"example","externalCustomerId":"example","riskScore":"Low","type":"Individual","onboardingLevel":"Started","status":"Active","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","reason":"Manual review required","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","externalId":"example","beneficiaryData":{"id":"example","beneficiaryTypes":["ubo"],"name":"Jane Doe","email":"jane.doe@example.com","beneficiaryPositions":["director"],"ownershipPercentage":42,"inRegistry":true,"status":"Active","customerType":"Individual","belongsTo":"example"},"individualBeneficiaries":[{"id":"example","beneficiaryTypes":[],"name":"Jane Doe","email":"jane.doe@example.com","beneficiaryPositions":[],"ownershipPercentage":42,"inRegistry":true,"status":"Active","customerType":"Individual","belongsTo":"example"}],"companyClaims":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","sub":"example","companyName":"Jane Doe","registrationNumber":"example","country":"AFG","legalAddress":"Alexanderplatz 1, 10178 Berlin, Germany","incorporatedOn":"2024-05-14T09:30:00.000Z","type":"DEFAULT","email":"jane.doe@example.com","phone":"+4915112345678","controlScheme":"example","taxId":"example","registrationLocation":"example","website":"example","postalAddress":"10178","updatedAt":"2024-05-14T09:30:00.000Z","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","addresses":[],"beneficiaries":[]}],"documents":[{"documentId":"3b241101-e2bb-4255-8caf-4136c566a962","workflowSessionId":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","documentType":"id_image_front","metadata":{"sumsubImageId":42,"mediaType":"image/jpg","journeyId":"example","documentType":"INCORPORATION_CERT","name":"Jane Doe","entryDate":42,"entryTime":"example","isSandbox":true,"status":"ACCEPTED","reviewResult":{"reviewAnswer":"GREEN","moderationComment":"Example description","clientComment":"Example description","rejectLabels":[],"reviewRejectType":"FINAL"},"deactivated":true},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","document":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","objectKey":"3b241101-e2bb-4255-8caf-4136c566a962","filename":"Jane Doe","mimetype":"DEFAULT","description":"Example description","cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","presignedUrl":"https://example.com/resource"}}],"tagsToEntity":[{"id":"tte_3b241101e2bb42558caf4136","tagId":"example","entityId":"example","entityType":"transactionReview","createdBy":"workspace","tags":{"id":"tag_3b241101e2bb42558caf4136","type":"transaction","title":"Example title","backgroundColor":"example","textColor":"example","workspaceId":"example","organizationId":"example","deletedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}],"customerWallets":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","blockchainNamespace":"tezos","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","bigData":[],"merkleScienceData":[],"chainalysisData":[]}],"companyBeneficiaries":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","cmsProjectId":"example","workspaceId":"example","organizationId":"example","externalCustomerId":"example","riskScore":"Low","type":"Individual","onboardingLevel":"Started","status":"Active","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","reason":"Manual review required","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","externalId":"example","beneficiaryData":{"id":"example","beneficiaryTypes":[],"name":"Jane Doe","email":"jane.doe@example.com","beneficiaryPositions":[],"ownershipPercentage":42,"inRegistry":true,"status":"Active","customerType":"Individual","belongsTo":"example"},"individualBeneficiaries":[],"companyClaims":[],"documents":[],"tagsToEntity":[],"customerWallets":[],"companyBeneficiaries":[]}]}]}]}}}},"default":{"$ref":"#/components/responses/error"}}}},"/companies":{"post":{"operationId":"companiesRouter-createCompany","summary":"Create company","description":"Creates a new Company customer in the workspace resolved from the API key. `externalId` is your own stable identifier for the company and is required; the response is the newly-created ComPilot company customer id (UUID). `cmsProjectId` is deprecated and ignored. Use `/companies/batch` to create many at once.","tags":["Company"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalId":{"type":"string"},"onboardingLevel":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded","Onboarding","KYB","Onboarded"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"softDeletedAt":{"type":"string","format":"date-time","nullable":true},"softDeletedBy":{"type":"string","nullable":true},"organizationId":{"type":"string"},"beneficiaryCompany":{"type":"object","properties":{"ownershipPercentage":{"type":"number"},"parentCompanyId":{"type":"string","description":"if this is present this means that the cmpany is beneficary of another company"},"inRegistry":{"type":"boolean","nullable":true},"beneficiaryType":{"type":"string","enum":["ubo","shareholder","representative","director"],"nullable":true}},"additionalProperties":false},"cmsProjectId":{"type":"string","description":"Deprecated, not needed anymore, will be removed in next releases"}},"required":["externalId","organizationId"],"additionalProperties":false},"example":{"externalId":"acme-gmbh-001","organizationId":"org_1234567890"}}}},"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string","format":"uuid"}}}},"default":{"$ref":"#/components/responses/error"}}},"get":{"operationId":"companiesRouter-getCompanies","summary":"Get companies","description":"List company customers in the workspace resolved from the API key, honoring the supplied filter/pagination parameters. Read-only; returns the matching company records with their associated review tags. Use `/companies/{customerId}/details` to expand a single company's full beneficiary graph.","tags":["Company"],"security":[{"Authorization":[]}],"parameters":[{"name":"cmsProjectId","in":"query","required":false,"schema":{"type":"string"},"example":"example"},{"name":"currentPage","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"number"}],"default":0},"example":0},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"number"}],"default":10},"example":10},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-05-14T09:30:00.000Z"},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-05-14T09:30:00.000Z"},{"name":"onBoardingLevel","in":"query","required":false,"schema":{"type":"string","enum":["Onboarding","KYB","Onboarded"]},"example":"Onboarding"},{"name":"softDeletedBefore","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-05-14T09:30:00.000Z"},{"name":"search","in":"query","required":false,"schema":{"type":"string"},"example":"example"},{"name":"includeGhostRecords","in":"query","required":false,"schema":{"type":"boolean"},"example":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"totalCount":{"type":"number"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customer_id":{"type":"string","format":"uuid"},"cms_project_id":{"type":"string"},"company_name":{"type":"string","nullable":true},"onboarding_level":{"type":"string","enum":["Onboarding","KYB","Onboarded"],"nullable":true},"date_onboarded":{"type":"string","format":"date-time"},"risk_score":{"type":"string","enum":["Low","Medium","High","No risk"],"nullable":true},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"],"nullable":true},"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"wallets":{"type":"array","items":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]}},"tagsToEntity":{"type":"array","items":{"type":"object","properties":{"id":{},"tagId":{"type":"string"},"entityId":{"type":"string"},"entityType":{"type":"string","enum":["transactionReview","customer","alert","wallet"]},"createdBy":{"type":"string","nullable":true},"tags":{"type":"object","properties":{"id":{},"type":{"type":"string","enum":["transaction","individual","company","wallet"]},"title":{"type":"string"},"backgroundColor":{"type":"string"},"textColor":{"type":"string"},"workspaceId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"deletedAt":{"type":"string","format":"date-time","nullable":true},"createdBy":{"type":"string","nullable":true},"updatedBy":{"type":"string","nullable":true}},"required":["id","type","title","backgroundColor","textColor","workspaceId"],"additionalProperties":false}},"required":["id","tagId","entityId","entityType","tags"],"additionalProperties":false},"nullable":true}},"required":["id","customer_id","cms_project_id","date_onboarded","status","country","wallets"],"additionalProperties":false}}},"required":["totalCount","data"],"additionalProperties":false},"example":{"totalCount":42,"data":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customer_id":"3b241101-e2bb-4255-8caf-4136c566a962","cms_project_id":"example","company_name":"Jane Doe","onboarding_level":"Onboarding","date_onboarded":"2024-05-14T09:30:00.000Z","risk_score":"Low","status":"Active","country":"AFG","wallets":["example"],"tagsToEntity":[{"id":"tte_3b241101e2bb42558caf4136","tagId":"example","entityId":"example","entityType":"transactionReview","createdBy":"workspace","tags":{"id":"tag_3b241101e2bb42558caf4136","type":"transaction","title":"Example title","backgroundColor":"example","textColor":"example","workspaceId":"example","organizationId":"example","deletedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}]}]}}}},"default":{"$ref":"#/components/responses/error"}}}},"/companies/batch":{"post":{"operationId":"companiesRouter-createCompanies","summary":"Create multiple companies","description":"Create a multiple companies for a given project.","tags":["Company"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"externalId":{"type":"string"},"onboardingLevel":{"type":"string","enum":["Onboarding","KYB","Onboarded"]},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"]},"riskScore":{"type":"string","enum":["Low","Medium","High","No risk"]},"claims":{"type":"object","properties":{"sub":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"registrationNumber":{"type":"string","nullable":true},"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)"},"legalAddress":{"type":"string","nullable":true},"incorporatedOn":{"type":"string","format":"date-time"},"type":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"controlScheme":{"type":"string","nullable":true},"taxId":{"type":"string","nullable":true},"registrationLocation":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"postalAddress":{"type":"string","nullable":true},"createdBy":{"type":"string"},"addresses":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false},"maxItems":100},"organizationId":{"type":"string"}},"required":["items","organizationId"],"additionalProperties":false},"example":{"items":[{"externalId":"example","onboardingLevel":"Onboarding","status":"Active","riskScore":"Low","claims":{"sub":"example","companyName":"Jane Doe","registrationNumber":"example","country":"AFG","legalAddress":"Alexanderplatz 1, 10178 Berlin, Germany","incorporatedOn":"2024-05-14T09:30:00.000Z","type":"DEFAULT","email":"jane.doe@example.com","phone":"+4915112345678","controlScheme":"example","taxId":"example","registrationLocation":"example","website":"example","postalAddress":"10178","createdBy":"workspace","addresses":["Alexanderplatz 1, 10178 Berlin, Germany"]}}],"organizationId":"example"}}}},"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalId":{"type":"string"}},"required":["id","externalId"],"additionalProperties":false}},"example":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","externalId":"example"}]}}},"default":{"$ref":"#/components/responses/error"}}},"delete":{"operationId":"companiesRouter-deleteCompanies","summary":"Delete multiple companies","description":"Delete multiple companies.","tags":["Company"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerIds","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"},"example":"example"}}},"default":{"$ref":"#/components/responses/error"}}}},"/companies/{customerId}/ownerships/batch":{"post":{"operationId":"companiesRouter-batchBeneficiaryOwnerships","summary":"Batch beneficiary company ownerships.","description":"Batch beneficiary company ownerships.","tags":["Company"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"beneficiaryCompanies":{"type":"array","items":{"type":"object","properties":{"beneficiaryCompanyCustomerId":{"type":"string","format":"uuid"},"beneficiaryType":{"type":"string","enum":["ubo","shareholder","representative","director"]},"ownershipPercentage":{"type":"number"}},"required":["beneficiaryCompanyCustomerId","beneficiaryType","ownershipPercentage"],"additionalProperties":false}},"beneficiaryIndividuals":{"type":"array","items":{"type":"object","properties":{"beneficiaryIndividualCustomerId":{"type":"string","format":"uuid"},"relation":{"type":"array","items":{"type":"string"}},"beneficiaryType":{"type":"string","enum":["ubo","shareholder","representative","director"]}},"required":["beneficiaryIndividualCustomerId","relation","beneficiaryType"],"additionalProperties":false}}},"additionalProperties":false},"example":{"beneficiaryCompanies":[{"beneficiaryCompanyCustomerId":"3b241101-e2bb-4255-8caf-4136c566a962","beneficiaryType":"ubo","ownershipPercentage":42}],"beneficiaryIndividuals":[{"beneficiaryIndividualCustomerId":"3b241101-e2bb-4255-8caf-4136c566a962","relation":["example"],"beneficiaryType":"ubo"}]}}}},"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"beneficiaryCompanies":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"}},"required":["customerId"],"additionalProperties":false},"nullable":true},"beneficiaryIndividuals":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"}},"required":["customerId"],"additionalProperties":false},"nullable":true}},"required":["customerId"],"additionalProperties":false},"example":{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","beneficiaryCompanies":[{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962"}],"beneficiaryIndividuals":[{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962"}]}}}},"default":{"$ref":"#/components/responses/error"}}}},"/companies/{customerId}/ownerships":{"get":{"operationId":"companiesRouter-getCompanyOwnerships","summary":"Get company ownerships","description":"Get company ownerships.","tags":["Company"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"beneficiaryCompanies":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"}},"required":["customerId"],"additionalProperties":false},"nullable":true},"beneficiaryIndividuals":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"}},"required":["customerId"],"additionalProperties":false},"nullable":true}},"additionalProperties":false},"example":{"beneficiaryCompanies":[{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962"}],"beneficiaryIndividuals":[{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962"}]}}}},"default":{"$ref":"#/components/responses/error"}}}},"/company/{customerId}/last-kyb-session":{"get":{"operationId":"companiesRouter-getLastKybSession","summary":"Get last customer kyb session.","description":"Get last customer kyb session.","tags":["Company"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"workspaceId","in":"query","required":false,"schema":{"type":"string"},"example":"example"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"address":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}],"nullable":true},"cmsProjectId":{"type":"string"},"result":{"type":"string","enum":["Passed","ToBeManuallyChecked","Rejected","Retry"],"nullable":true},"reviewAnswer":{"type":"string","enum":["GREEN","RED","YELLOW"],"nullable":true},"reviewRejectType":{"type":"string","enum":["FINAL","RETRY"],"nullable":true},"sandboxMode":{"type":"boolean","nullable":true},"status":{"type":"string","enum":["NotStarted","Started","Closed"],"nullable":true},"ip":{"type":"string","nullable":true},"isBeneficiary":{"type":"boolean","nullable":true},"sandboxSimulated":{"type":"boolean","nullable":true},"beneficiaries":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"applicantId":{"type":"string"},"externalUserId":{"type":"string"},"calculatedResult":{"type":"string","enum":["Passed","ToBeManuallyChecked","Rejected","Retry"],"nullable":true},"reviewAnswer":{"type":"string","enum":["GREEN","RED","YELLOW"],"nullable":true},"reviewRejectType":{"type":"string","enum":["FINAL","RETRY"],"nullable":true},"type":{"type":"string","enum":["ubo","shareholder","representative","director"],"nullable":true},"name":{"type":"string","nullable":true},"levelName":{"type":"string"}},"required":["customerId","applicantId","externalUserId","levelName"],"additionalProperties":false},"nullable":true},"workflowId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"customerStatus":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"],"nullable":true},"topographCountry":{"type":"string","nullable":true}},"required":["id","customerId","cmsProjectId","workflowId","createdAt","updatedAt"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","address":"Alexanderplatz 1, 10178 Berlin, Germany","cmsProjectId":"example","result":"Passed","reviewAnswer":"GREEN","reviewRejectType":"FINAL","sandboxMode":true,"status":"NotStarted","ip":"203.0.113.42","isBeneficiary":true,"sandboxSimulated":true,"beneficiaries":[{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","applicantId":"example","externalUserId":"example","calculatedResult":"Passed","reviewAnswer":"GREEN","reviewRejectType":"FINAL","type":"ubo","name":"Jane Doe","levelName":"Jane Doe"}],"workflowId":"3b241101-e2bb-4255-8caf-4136c566a962","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","customerStatus":"Active","topographCountry":"DE"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/activity-logs":{"get":{"operationId":"individualsRouter-activityLogs-activityLogs","summary":"Get individual activity logs","description":"Get individual activity logs.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string"},"example":"example"},{"name":"currentPage","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"number"}],"default":0},"example":0},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"number"}],"default":50},"example":50},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-05-14T09:30:00.000Z"},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-05-14T09:30:00.000Z"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"totalCount":{"type":"number"},"customerId":{"type":"string"},"activityLogs":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"customer_id":{"type":"string"},"wallet":{"type":"string","nullable":true},"cms_project_id":{"type":"string"},"type":{"type":"string"},"id":{"type":"string","nullable":true},"data":{"type":"object","properties":{"topic":{"type":"string"},"data":{"type":"object","properties":{"journeyId":{"type":"string","nullable":true}},"additionalProperties":false}},"required":["topic","data"],"additionalProperties":false},"date":{"type":"string","format":"date-time"},"event":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["APPROVED","SUBMISSION_REQUIRED","RESUBMISSION_REQUIRED","REJECTED","PENDING_VERIFICATION"]},"alias":{"type":"string"},"sandbox":{"type":"boolean"}},"required":["status","alias","sandbox"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["APPROVED","SUBMISSION_REQUIRED","RESUBMISSION_REQUIRED","REJECTED","PENDING_VERIFICATION"]},"type":{"type":"string","enum":["ID_DOCUMENT","LIVENESS","PROOF_OF_ADDRESS","PHONE","EMAIL"]},"sandbox":{"type":"boolean"},"metadata":{"type":"object","properties":{"ip":{"type":"string"},"user_agent":{"type":"string"},"platform":{"type":"string"},"browser_name":{"type":"string"},"browser_version":{"type":"string"},"device":{"type":"string"},"customer_language":{"type":"string"}},"required":["ip","user_agent","platform","browser_name","browser_version","device","customer_language"],"additionalProperties":false}},"required":["status","type","sandbox","metadata"],"additionalProperties":false},{"anyOf":[{"type":"object","properties":{"topic":{"type":"string","enum":["NEXERA_SSID"]},"subject":{"type":"string","description":"Project ID"},"data":{"type":"object","properties":{"type":{"type":"string","enum":["NEXERA_SSID_ACCESS_TOKEN","NEXERA_SSID_GBG_END","NEXERA_SSID_GBG_START","NEXERA_SSID_GBG_IDSCAN_COMPLETE","NEXERA_SSID_GBG_ID3_COMPLETE","NEXERA_SSID_SUMSUB_KYC_START","NEXERA_SSID_SUMSUB_KYB_START","NEXERA_SSID_SUMSUB_JWT_GENERATED","NEXERA_SSID_SUMSUB_KYC_COMPLETE","NEXERA_SSID_SUMSUB_KYB_COMPLETE","NEXERA_SSID_SUMSUB_REVIEW_COMPLETE","NEXERA_SSID_PROOF_OF_RESIDENCE_COMPLETE","NEXERA_SSID_CONTACT_INFORMATION_COMPLETE","NEXERA_SSID_VIDEO_KYC_COMPLETE","NEXERA_SSID_SDK_VERIFICATION","NEXERA_SSID_SCORECHAIN_REQUEST","NEXERA_SSID_IP_CHECK_REQUEST","NEXERA_SSID_BIG_BITRANK_REQUEST","NEXERA_SSID_MERKLE_SCIENCE_REQUEST","NEXERA_SSID_CHAINALYSIS_REQUEST","NEXERA_SSID_TRMLABS_REQUEST","NEXERA_SSID_CRYSTAL_INTELLIGENCE_REQUEST","NEXERA_SSID_COMPLY_ADVANTAGE_REQUEST","NEXERA_SSID_INTEGRATED_SCORECHAIN_REQUEST","NEXERA_SSID_INTEGRATED_BIG_BITRANK_REQUEST","NEXERA_SSID_INTEGRATED_IP_CHECK_REQUEST","NEXERA_SSID_INTEGRATED_COMPLY_ADVANTAGE_REQUEST","NEXERA_SSID_TRANSACTION_CREATED","NEXERA_SSID_KYT_START","NEXERA_SSID_KYT_RULE_FAILED","NEXERA_SSID_KYT_RULE_SUCCESS","NEXERA_SSID_KYT_RULE_SKIPPED","NEXERA_SSID_KYT_AML","NEXERA_SSID_NOTABENE_REQUEST"]},"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}],"nullable":true},"transactionHash":{"type":"string","nullable":true},"blockchainNamespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"],"nullable":true},"customerId":{"type":"string"},"transactionId":{"type":"string"},"cmsProjectId":{"type":"string"},"duration":{"type":"number","description":"Duration in seconds"},"gbgJourneyId":{"type":"string"},"sessionId":{"type":"string"},"did":{"type":"string"},"time":{"type":"string"}},"required":["type","cmsProjectId","duration","time"],"additionalProperties":false}},"required":["topic","subject","data"],"additionalProperties":false},{"type":"object","properties":{"topic":{"type":"string","enum":["SYNAPS_SESSION_CREATED"]},"subject":{"type":"string","description":"Project ID"},"data":{"type":"object","properties":{"sessionId":{"type":"string"},"customerId":{"type":"string"},"time":{"type":"string"},"event":{"type":"object","properties":{"status":{"type":"string","enum":["APPROVED","SUBMISSION_REQUIRED","RESUBMISSION_REQUIRED","REJECTED","PENDING_VERIFICATION"]},"alias":{"type":"string"},"sandbox":{"type":"boolean"}},"required":["status","alias","sandbox"],"additionalProperties":false}},"required":["sessionId","customerId","time","event"],"additionalProperties":false}},"required":["topic","subject","data"],"additionalProperties":false},{"type":"object","properties":{"topic":{"type":"string","enum":["SYNAPS_SESSION_UPDATED"]},"subject":{"type":"string","description":"Project ID"},"data":{"type":"object","properties":{"sessionId":{"type":"string"},"customerId":{"type":"string"},"time":{"type":"string"},"event":{"type":"object","properties":{"status":{"type":"string","enum":["APPROVED","SUBMISSION_REQUIRED","RESUBMISSION_REQUIRED","REJECTED","PENDING_VERIFICATION"]},"alias":{"type":"string"},"sandbox":{"type":"boolean"}},"required":["status","alias","sandbox"],"additionalProperties":false}},"required":["sessionId","customerId","time","event"],"additionalProperties":false}},"required":["topic","subject","data"],"additionalProperties":false},{"type":"object","properties":{"topic":{"type":"string","enum":["SYNAPS_STEP_CREATED"]},"subject":{"type":"string","description":"Project ID"},"data":{"type":"object","properties":{"sessionId":{"type":"string"},"stepId":{"type":"string"},"customerId":{"type":"string"},"time":{"type":"string"},"event":{"type":"object","properties":{"status":{"type":"string","enum":["APPROVED","SUBMISSION_REQUIRED","RESUBMISSION_REQUIRED","REJECTED","PENDING_VERIFICATION"]},"type":{"type":"string","enum":["ID_DOCUMENT","LIVENESS","PROOF_OF_ADDRESS","PHONE","EMAIL"]},"sandbox":{"type":"boolean"},"metadata":{"type":"object","properties":{"ip":{"type":"string"},"user_agent":{"type":"string"},"platform":{"type":"string"},"browser_name":{"type":"string"},"browser_version":{"type":"string"},"device":{"type":"string"},"customer_language":{"type":"string"}},"required":["ip","user_agent","platform","browser_name","browser_version","device","customer_language"],"additionalProperties":false}},"required":["status","type","sandbox","metadata"],"additionalProperties":false}},"required":["sessionId","stepId","customerId","time","event"],"additionalProperties":false}},"required":["topic","subject","data"],"additionalProperties":false},{"type":"object","properties":{"topic":{"type":"string","enum":["SYNAPS_STEP_UPDATED"]},"subject":{"type":"string","description":"Project ID"},"data":{"type":"object","properties":{"sessionId":{"type":"string"},"stepId":{"type":"string"},"customerId":{"type":"string"},"time":{"type":"string"},"event":{"type":"object","properties":{"status":{"type":"string","enum":["APPROVED","SUBMISSION_REQUIRED","RESUBMISSION_REQUIRED","REJECTED","PENDING_VERIFICATION"]},"type":{"type":"string","enum":["ID_DOCUMENT","LIVENESS","PROOF_OF_ADDRESS","PHONE","EMAIL"]},"sandbox":{"type":"boolean"},"metadata":{"type":"object","properties":{"ip":{"type":"string"},"user_agent":{"type":"string"},"platform":{"type":"string"},"browser_name":{"type":"string"},"browser_version":{"type":"string"},"device":{"type":"string"},"customer_language":{"type":"string"}},"required":["ip","user_agent","platform","browser_name","browser_version","device","customer_language"],"additionalProperties":false}},"required":["status","type","sandbox","metadata"],"additionalProperties":false}},"required":["sessionId","stepId","customerId","time","event"],"additionalProperties":false}},"required":["topic","subject","data"],"additionalProperties":false},{"type":"object","properties":{"topic":{"type":"string","enum":["CUSTOMER_CREATED"]},"subject":{"type":"string","description":"Customer ID"},"data":{"type":"object","properties":{"cmsProjectId":{"type":"string"},"customerId":{"type":"string","format":"uuid"},"externalCustomerId":{"type":"string","nullable":true},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"riskScore":{"type":"string","enum":["Low","Medium","High","No risk"],"nullable":true},"type":{"type":"string","enum":["Individual","Company"],"nullable":true},"onboardingLevel":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded","Onboarding","KYB","Onboarded"],"nullable":true},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time","nullable":true},"reason":{"type":"string","nullable":true},"deletedBy":{"type":"string","nullable":true},"deletedAt":{"type":"string","format":"date-time","nullable":true}},"required":["cmsProjectId","customerId","createdBy","updatedBy","id","createdAt"],"additionalProperties":false}},"required":["topic","subject","data"],"additionalProperties":false},{"type":"object","properties":{"topic":{"type":"string","enum":["CUSTOMER_UPDATED"]},"subject":{"type":"string","description":"Customer ID"},"data":{"type":"object","properties":{"cmsProjectId":{"type":"string"},"customerId":{"type":"string","format":"uuid"},"externalCustomerId":{"type":"string","nullable":true},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"riskScore":{"type":"string","enum":["Low","Medium","High","No risk"],"nullable":true},"type":{"type":"string","enum":["Individual","Company"],"nullable":true},"onboardingLevel":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded","Onboarding","KYB","Onboarded"],"nullable":true},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time","nullable":true},"reason":{"type":"string","nullable":true},"deletedBy":{"type":"string","nullable":true},"deletedAt":{"type":"string","format":"date-time","nullable":true}},"required":["cmsProjectId","customerId","createdBy","updatedBy","id","createdAt"],"additionalProperties":false}},"required":["topic","subject","data"],"additionalProperties":false},{"type":"object","properties":{"topic":{"type":"string","enum":["CUSTOMER_DELETED"]},"subject":{"type":"string","description":"Customer ID"},"data":{"type":"object","properties":{"cmsProjectId":{"type":"string"},"customerId":{"type":"string","format":"uuid"},"externalCustomerId":{"type":"string","nullable":true},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"riskScore":{"type":"string","enum":["Low","Medium","High","No risk"],"nullable":true},"type":{"type":"string","enum":["Individual","Company"],"nullable":true},"onboardingLevel":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded","Onboarding","KYB","Onboarded"],"nullable":true},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time","nullable":true},"reason":{"type":"string","nullable":true},"deletedBy":{"type":"string","nullable":true},"deletedAt":{"type":"string","format":"date-time","nullable":true}},"required":["cmsProjectId","customerId","createdBy","updatedBy","id","createdAt"],"additionalProperties":false}},"required":["topic","subject","data"],"additionalProperties":false},{"type":"object","properties":{"topic":{"type":"string","enum":["CUSTOMER_STATUS_CHANGED"]},"subject":{"type":"string","description":"Project ID"},"data":{"type":"object","properties":{"cmsProjectId":{"type":"string"},"customerId":{"type":"string","format":"uuid"},"externalClientId":{"type":"string"},"fromStatus":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"]},"toStatus":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"]}},"required":["cmsProjectId","customerId","toStatus"],"additionalProperties":false}},"required":["topic","subject","data"],"additionalProperties":false},{"type":"object","properties":{"topic":{"type":"string","enum":["CUSTOMER_RISK_LEVEL_CHANGED"]},"subject":{"type":"string","description":"Project ID"},"data":{"type":"object","properties":{"cmsProjectId":{"type":"string"},"customerId":{"type":"string","format":"uuid"},"externalCustomerId":{"type":"string"},"fromRiskLevel":{"type":"string","enum":["Low","Medium","High","No risk"]},"toRiskLevel":{"type":"string","enum":["Low","Medium","High","No risk"]},"riskNumber":{"type":"number"}},"required":["cmsProjectId","customerId","toRiskLevel"],"additionalProperties":false}},"required":["topic","subject","data"],"additionalProperties":false},{"type":"object","properties":{"topic":{"type":"string","enum":["CUSTOMER_COUNTRY"]},"subject":{"type":"string","description":"Project ID"},"data":{"type":"object","properties":{"cmsProjectId":{"type":"string"},"customerId":{"type":"string","format":"uuid"},"externalCustomerId":{"type":"string"},"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)"}},"required":["cmsProjectId","customerId","country"],"additionalProperties":false}},"required":["topic","subject","data"],"additionalProperties":false},{"type":"object","properties":{"topic":{"type":"string","enum":["SIGNATURE_REQUEST"]},"subject":{"type":"string","description":"ProjectId"},"data":{"type":"object","properties":{"isAuthorized":{"type":"boolean"},"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]},"signatureResponse":{"type":"object","properties":{"signature":{"type":"string","description":"0x string"},"blockExpiration":{"type":"number"}},"required":["signature","blockExpiration"],"additionalProperties":false},"requestData":{"type":"object","properties":{"workflowId":{"type":"string","format":"uuid"},"chainId":{"type":"string","enum":["1","137","80002","43114","43113","42161","421614","11155111","8453","84532","56","97","1284","1285","10","11155420","1291","295","296","254","2024","20241133","9990","3338","2040","78600","72080","50","51"],"description":"a numeric value that identifies the chain of the address. There are many sites that retrieve information on chainIDs such as <a href='https://chainlist.org/'>https://chainlist.org</a>."},"contractAddress":{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},"functionName":{"type":"string"},"args":{"type":"array","items":{}},"blockExpiration":{"type":"integer"},"nonce":{"type":"integer"}},"required":["chainId","contractAddress","functionName","args"],"additionalProperties":false},"cmsProjectId":{"type":"string"},"customerId":{"type":"string"},"time":{"type":"string"}},"required":["isAuthorized","wallet","requestData","cmsProjectId","customerId","time"],"additionalProperties":false}},"required":["topic","subject","data"],"additionalProperties":false},{"type":"object","properties":{"topic":{"type":"string","enum":["SIGNATURE_ON_CHAIN_VERIFICATION"]},"subject":{"type":"string","description":"ProjectId"},"data":{"type":"object","properties":{"chainId":{"type":"string","enum":["1","137","80002","43114","43113","42161","421614","11155111","8453","84532","56","97","1284","1285","10","11155420","1291","295","296","254","2024","20241133","9990","3338","2040","78600","72080","50","51"],"description":"a numeric value that identifies the chain of the address. There are many sites that retrieve information on chainIDs such as <a href='https://chainlist.org/'>https://chainlist.org</a>."},"nonce":{"type":"number"},"blockExpiration":{"type":"number"},"contractAddress":{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},"wallet":{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},"functionCallData":{"type":"string"},"cmsProjectId":{"type":"string"},"customerId":{"type":"string"},"time":{"type":"string"}},"required":["chainId","nonce","blockExpiration","contractAddress","wallet","functionCallData","cmsProjectId","customerId","time"],"additionalProperties":false}},"required":["topic","subject","data"],"additionalProperties":false},{"type":"object","properties":{"topic":{"type":"string","enum":["TEZOS_SIGNATURE_REQUEST"]},"subject":{"type":"string","description":"ProjectId"},"data":{"type":"object","properties":{"isAuthorized":{"type":"boolean"},"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]},"signatureResponse":{"type":"object","properties":{"signature":{"type":"string"},"blockExpiration":{"type":"number"}},"required":["signature","blockExpiration"],"additionalProperties":false},"requestData":{"type":"object","properties":{"workflowId":{"type":"string","format":"uuid"},"chainID":{"type":"string","enum":["NetXdQprcVkpaWU","NetXnHfVqm9iesp"],"description":"a numeric value that identifies the chain of the address. There are many sites that retrieve information on chainIDs such as <a href='https://chainlist.org/'>https://chainlist.org</a>."},"contractAddress":{"type":"string","description":"Tezos contract address"},"functionName":{"type":"string","description":"Tezos entrypoint name"},"args":{"type":"string"},"blockExpiration":{"type":"integer"},"nonce":{"type":"integer"}},"required":["chainID","contractAddress","functionName","args"],"additionalProperties":false},"cmsProjectId":{"type":"string"},"customerId":{"type":"string"},"time":{"type":"string"}},"required":["isAuthorized","wallet","requestData","cmsProjectId","customerId","time"],"additionalProperties":false}},"required":["topic","subject","data"],"additionalProperties":false},{"type":"object","properties":{"topic":{"type":"string","enum":["TEZOS_SIGNATURE_ON_CHAIN_VERIFICATION"]},"subject":{"type":"string","description":"ProjectId"},"data":{"type":"object","properties":{"chainId":{"type":"string","enum":["NetXdQprcVkpaWU","NetXnHfVqm9iesp"],"description":"a numeric value that identifies the chain of the address. There are many sites that retrieve information on chainIDs such as <a href='https://chainlist.org/'>https://chainlist.org</a>."},"nonce":{"type":"number"},"blockExpiration":{"type":"number"},"contractAddress":{"type":"string","description":"Tezos contract address"},"wallet":{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},"functionCallData":{"type":"string"},"cmsProjectId":{"type":"string"},"customerId":{"type":"string"},"time":{"type":"string"}},"required":["chainId","nonce","blockExpiration","contractAddress","wallet","functionCallData","cmsProjectId","customerId","time"],"additionalProperties":false}},"required":["topic","subject","data"],"additionalProperties":false},{"type":"object","properties":{"topic":{"type":"string","enum":["RULE_ENGINE"]},"subject":{"type":"string","description":"ProjectId"},"data":{"type":"object","properties":{"type":{"type":"string","enum":["SCENARIO_EXECUTION","SDK_VERIFICATION"]},"result":{"type":"string","enum":["valid","not-valid","skipped","error","unknown"]},"scenarioId":{"type":"string"},"scenarioExecutionId":{"type":"string"},"cmsProjectId":{"type":"string"},"customerId":{"type":"string"},"time":{"type":"string"}},"required":["type","result","scenarioExecutionId","cmsProjectId","customerId","time"],"additionalProperties":false}},"required":["topic","subject","data"],"additionalProperties":false}]}],"nullable":true}},"required":["customer_id","cms_project_id","type","data","date"],"additionalProperties":false},{"type":"object","properties":{"customer_id":{"type":"string"},"wallet":{"type":"string","nullable":true},"cms_project_id":{"type":"string"},"type":{"type":"string"},"id":{"type":"string","nullable":true},"data":{"type":"object","properties":{"executions":{"type":"array","items":{"type":"object","properties":{"scenarioId":{"type":"string"},"scenarioName":{"type":"string","nullable":true},"rules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"execution_id":{"type":"string"},"cms_object_id":{"type":"string"},"object_type":{"type":"string"},"result":{"type":"object","properties":{"result":{"type":"object","properties":{"reasons":{"type":"array","items":{}},"is_valid":{"type":"boolean"}},"required":["reasons","is_valid"],"additionalProperties":false,"nullable":true}},"additionalProperties":false,"nullable":true},"rule_data":{"type":"object","properties":{"queryId":{"description":"Unique ID for the query"},"id":{"description":"Unique ID for the query"},"requestId":{"type":"number","nullable":true,"description":"Request ID for ZKPs"},"attribute":{"anyOf":[{"type":"string"},{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"],"additionalProperties":false}]},"secondaryAttribute":{"anyOf":[{"type":"string"},{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"],"additionalProperties":false}],"nullable":true},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"number"}}],"nullable":true},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"displayMode":{"type":"string","enum":["amount","percentage"],"nullable":true},"timeframe":{"type":"string","enum":["daily","weekly","monthly","yearly"],"nullable":true},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","enum":["ACTIVE_USERS_ADDRESSES"],"nullable":true},"type":{"type":"string","enum":["IDInformation","IDInformationTfhe","SelfieImage","IDImage","ProofOfResidence","AMLScreeningsResults","ID3","IDScan","IDScanSelfie","IDScanPassport"],"nullable":true}},"required":["attribute","operator"],"additionalProperties":false,"nullable":true},"status":{"type":"string","enum":["valid","not-valid","skipped","error","unknown"],"nullable":true},"executed_at":{"type":"string","format":"date-time"},"rules_engine_version":{"type":"string","enum":["v1","v2"]}},"required":["id","execution_id","cms_object_id","object_type","executed_at","rules_engine_version"],"additionalProperties":false}},"scenarioStatus":{"type":"string","enum":["valid","not-valid","skipped","error","unknown"],"nullable":true},"executed_at":{"type":"string","format":"date-time"}},"required":["scenarioId","rules","executed_at"],"additionalProperties":false},"nullable":true},"execution_status":{"type":"string","enum":["valid","not-valid","skipped","error","unknown"],"nullable":true}},"additionalProperties":false},"date":{"type":"string","format":"date-time"}},"required":["customer_id","wallet","cms_project_id","type","data","date"],"additionalProperties":false}]}}},"required":["totalCount","customerId","activityLogs"],"additionalProperties":false},"example":{"totalCount":42,"customerId":"example","activityLogs":[{"customer_id":"example","wallet":"example","cms_project_id":"example","type":"DEFAULT","id":"example","data":{"topic":"example","data":{"journeyId":"example"}},"date":"2024-05-14T09:30:00.000Z","event":{"status":"APPROVED","alias":"example","sandbox":true}}]}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/addresses":{"get":{"operationId":"individualsRouter-addresses-getIndividualAddresses","summary":"Get individual addresses","description":"Get a list of a individual's addresses.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"formatted":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","formatted","street","city","state","region","postalCode","locality","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"example":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","formatted":"Alexanderplatz 1, 10178 Berlin, Germany","street":"Alexanderplatz 1","city":"Berlin","state":"Berlin","region":"Berlin","postalCode":"10178","locality":"Mitte","country":"AFG","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}]}}},"default":{"$ref":"#/components/responses/error"}}},"post":{"operationId":"individualsRouter-addresses-createIndividualAddress","summary":"Create individual address","description":"Create a new address for an individual.","tags":["Individuals"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"formatted":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true}},"additionalProperties":false},"example":{"formatted":"Alexanderplatz 1, 10178 Berlin, Germany","street":"Alexanderplatz 1","city":"Berlin","state":"Berlin","region":"Berlin","postalCode":"10178","locality":"Mitte","country":"AFG"}}}},"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"formatted":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","formatted","street","city","state","region","postalCode","locality","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","formatted":"Alexanderplatz 1, 10178 Berlin, Germany","street":"Alexanderplatz 1","city":"Berlin","state":"Berlin","region":"Berlin","postalCode":"10178","locality":"Mitte","country":"AFG","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/addresses/{id}":{"delete":{"operationId":"individualsRouter-addresses-deleteIndividualAddress","summary":"Delete individual address","description":"Delete an individual's address.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962"}}}},"default":{"$ref":"#/components/responses/error"}}},"patch":{"operationId":"individualsRouter-addresses-updateIndividualAddress","summary":"Update individual address","description":"Update a individual's address.","tags":["Individuals"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"formatted":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true}},"additionalProperties":false},"example":{"formatted":"Alexanderplatz 1, 10178 Berlin, Germany","street":"Alexanderplatz 1","city":"Berlin","state":"Berlin","region":"Berlin","postalCode":"10178","locality":"Mitte","country":"AFG"}}}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"formatted":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","formatted","street","city","state","region","postalCode","locality","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","formatted":"Alexanderplatz 1, 10178 Berlin, Germany","street":"Alexanderplatz 1","city":"Berlin","state":"Berlin","region":"Berlin","postalCode":"10178","locality":"Mitte","country":"AFG","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/claims/{id}":{"patch":{"operationId":"individualsRouter-claims-updateIndividualClaim","summary":"Update individual claim","description":"Update the individual claim.","tags":["Individuals"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sub":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"givenName":{"type":"string","nullable":true},"familyName":{"type":"string","nullable":true},"middleName":{"type":"string","nullable":true},"nickname":{"type":"string","nullable":true},"preferredUsername":{"type":"string","nullable":true},"profile":{"type":"string","nullable":true},"picture":{"type":"string","nullable":true},"pictureBase64":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"birthdate":{"type":"string","format":"date-time","nullable":true},"zoneinfo":{"type":"string","nullable":true},"locale":{"type":"string","nullable":true},"countryOfResidence":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"nationality":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true}},"additionalProperties":false},"example":{"sub":"example","name":"Jane Doe","givenName":"Jane Doe","familyName":"Jane Doe","middleName":"Jane Doe","nickname":"Jane Doe","preferredUsername":"Jane Doe","profile":"example","picture":"example","pictureBase64":"example","website":"example","gender":"example","birthdate":"2024-05-14T09:30:00.000Z","zoneinfo":"example","locale":"example","countryOfResidence":"AFG","nationality":"AFG"}}}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}}},"default":{"$ref":"#/components/responses/error"}}},"delete":{"operationId":"individualsRouter-claims-deleteIndividualClaim","summary":"Delete individual claim","description":"Delete the individual claim.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/claims":{"post":{"operationId":"individualsRouter-claims-createIndividualClaim","summary":"Create individual claim","description":"Create the individual claim. Only one individual claim per individual allowed.","tags":["Individuals"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sub":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"givenName":{"type":"string","nullable":true},"familyName":{"type":"string","nullable":true},"middleName":{"type":"string","nullable":true},"nickname":{"type":"string","nullable":true},"preferredUsername":{"type":"string","nullable":true},"profile":{"type":"string","nullable":true},"picture":{"type":"string","nullable":true},"pictureBase64":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"birthdate":{"type":"string","format":"date-time"},"zoneinfo":{"type":"string","nullable":true},"locale":{"type":"string","nullable":true},"countryOfResidence":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"nationality":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true}},"additionalProperties":false},"example":{"sub":"example","name":"Jane Doe","givenName":"Jane Doe","familyName":"Jane Doe","middleName":"Jane Doe","nickname":"Jane Doe","preferredUsername":"Jane Doe","profile":"example","picture":"example","pictureBase64":"example","website":"example","gender":"example","birthdate":"2024-05-14T09:30:00.000Z","zoneinfo":"example","locale":"example","countryOfResidence":"AFG","nationality":"AFG"}}}},"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"sub":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"givenName":{"type":"string","nullable":true},"familyName":{"type":"string","nullable":true},"middleName":{"type":"string","nullable":true},"nickname":{"type":"string","nullable":true},"preferredUsername":{"type":"string","nullable":true},"profile":{"type":"string","nullable":true},"picture":{"type":"string","nullable":true},"pictureBase64":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"birthdate":{"type":"string","format":"date-time","nullable":true},"zoneinfo":{"type":"string","nullable":true},"locale":{"type":"string","nullable":true},"countryOfResidence":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"nationality":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"updatedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","sub","name","givenName","familyName","middleName","nickname","preferredUsername","profile","picture","pictureBase64","website","gender","zoneinfo","locale","createdAt","createdBy","updatedBy"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","sub":"example","name":"Jane Doe","givenName":"Jane Doe","familyName":"Jane Doe","middleName":"Jane Doe","nickname":"Jane Doe","preferredUsername":"Jane Doe","profile":"example","picture":"example","pictureBase64":"example","website":"example","gender":"example","birthdate":"2024-05-14T09:30:00.000Z","zoneinfo":"example","locale":"example","countryOfResidence":"AFG","nationality":"AFG","updatedAt":"2024-05-14T09:30:00.000Z","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/contact-information":{"post":{"operationId":"individualsRouter-contactInformation-createContactInformation","summary":"Add contact information for a individual.","description":"Add contact information for a individual.","tags":["Individuals"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"information":{"type":"object","properties":{"email":{"type":"string","format":"email"},"phone":{"type":"string","minLength":4,"maxLength":32},"twitter":{"type":"string"},"discord":{"type":"string"},"telegram":{"type":"string"}},"additionalProperties":false},"softDeletedBy":{"type":"string","nullable":true}},"required":["information"],"additionalProperties":false},"example":{"information":{"email":"jane.doe@example.com","phone":"+4915112345678","twitter":"example","discord":"example","telegram":"example"},"softDeletedBy":"example"}}}},"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"information":{"type":"object","properties":{"email":{"type":"string","format":"email"},"phone":{"type":"string","minLength":4,"maxLength":32},"twitter":{"type":"string"},"discord":{"type":"string"},"telegram":{"type":"string"}},"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","information","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","information":{"email":"jane.doe@example.com","phone":"+4915112345678","twitter":"example","discord":"example","telegram":"example"},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/emails":{"get":{"operationId":"individualsRouter-emails-getIndividualEmails","summary":"Get individual email addresses","description":"Get a list of a individual's email addresses.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"email":{"type":"string"},"verified":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","email","verified","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"example":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","email":"jane.doe@example.com","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}]}}},"default":{"$ref":"#/components/responses/error"}}},"post":{"operationId":"individualsRouter-emails-createIndividualEmail","summary":"Add individual email address","description":"Add a new email address for a individual.","tags":["Individuals"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email"},"verified":{"type":"boolean","nullable":true},"updatedBy":{"type":"string"}},"required":["email"],"additionalProperties":false},"example":{"email":"jane.doe@example.com","verified":true,"updatedBy":"workspace"}}}},"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"email":{"type":"string"},"verified":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","email","verified","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","email":"jane.doe@example.com","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/emails/{id}":{"delete":{"operationId":"individualsRouter-emails-deleteIndividualEmail","summary":"Delete individual email address","description":"Delete a individual's email address.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962"}}}},"default":{"$ref":"#/components/responses/error"}}},"patch":{"operationId":"individualsRouter-emails-updateIndividualEmail","summary":"Update individual email address","description":"Update a individual's email address.","tags":["Individuals"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"verified":{"type":"boolean","nullable":true}},"additionalProperties":false},"example":{"email":"jane.doe@example.com","verified":true}}}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"email":{"type":"string"},"verified":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","email","verified","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","email":"jane.doe@example.com","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/ips":{"get":{"operationId":"individualsRouter-ip-getIPs","summary":"Get individual IP addresses","description":"Get a list of a individual's IP addresses.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"ipAddress":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","ipAddress","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"example":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","ipAddress":"Alexanderplatz 1, 10178 Berlin, Germany","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}]}}},"default":{"$ref":"#/components/responses/error"}}},"post":{"operationId":"individualsRouter-ip-createIP","summary":"Add individual IP address","description":"Add a new IP address for a individual.","tags":["Individuals"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ipAddress":{"type":"string"},"updatedBy":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"example":{"ipAddress":"Alexanderplatz 1, 10178 Berlin, Germany","updatedBy":"workspace"}}}},"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"ipAddress":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","ipAddress","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","ipAddress":"Alexanderplatz 1, 10178 Berlin, Germany","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/ips/{id}":{"delete":{"operationId":"individualsRouter-ip-deleteIP","summary":"Delete individual IP address","description":"Delete a individual's IP address.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/ips/:id":{"patch":{"operationId":"individualsRouter-ip-updateIP","summary":"Update individual IP address","description":"Update a individual's IP address.","tags":["Individuals"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"ipAddress":{"type":"string"}},"required":["id"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","ipAddress":"Alexanderplatz 1, 10178 Berlin, Germany"}}}},"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"ipAddress":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","ipAddress","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","ipAddress":"Alexanderplatz 1, 10178 Berlin, Germany","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/phone-numbers":{"get":{"operationId":"individualsRouter-phoneNumbers-getIndividualPhoneNumbers","summary":"Get individual phone numbers","description":"Get a list of a individual's phone numbers.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"phoneNumber":{"type":"string"},"verified":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","phoneNumber","verified","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"example":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","phoneNumber":"+4915112345678","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}]}}},"default":{"$ref":"#/components/responses/error"}}},"post":{"operationId":"individualsRouter-phoneNumbers-createIndividualPhoneNumber","summary":"Add individual phone number","description":"Add a new phone number for a individual.","tags":["Individuals"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumber":{"type":"string"},"verified":{"type":"boolean","nullable":true},"updatedBy":{"type":"string"}},"required":["phoneNumber"],"additionalProperties":false},"example":{"phoneNumber":"+4915112345678","verified":true,"updatedBy":"workspace"}}}},"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"phoneNumber":{"type":"string"},"verified":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","phoneNumber","verified","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","phoneNumber":"+4915112345678","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/phone-numbers/{id}":{"delete":{"operationId":"individualsRouter-phoneNumbers-deleteIndividualPhoneNumber","summary":"Delete individual phone number","description":"Delete a individual's phone number.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962"}}}},"default":{"$ref":"#/components/responses/error"}}},"patch":{"operationId":"individualsRouter-phoneNumbers-updateIndividualPhoneNumber","summary":"Update individual phone number","description":"Update a individual's phone number.","tags":["Individuals"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumber":{"type":"string"},"verified":{"type":"boolean","nullable":true}},"additionalProperties":false},"example":{"phoneNumber":"+4915112345678","verified":true}}}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"phoneNumber":{"type":"string"},"verified":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","phoneNumber","verified","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","phoneNumber":"+4915112345678","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/wallets":{"get":{"operationId":"individualsRouter-wallets-getIndividualWallets","summary":"Get individual wallets","description":"Get a list of a individual's wallets.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]},"blockchainNamespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"],"nullable":true},"customerId":{"type":"string","format":"uuid"},"verified":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","wallet","customerId","verified","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"example":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","blockchainNamespace":"tezos","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}]}}},"default":{"$ref":"#/components/responses/error"}}},"post":{"operationId":"individualsRouter-wallets-createIndividualWallet","summary":"Add individual wallet","description":"Add a new wallet for a individual.","tags":["Individuals"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]},"blockchainNamespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"],"nullable":true},"verified":{"type":"boolean","nullable":true}},"required":["wallet"],"additionalProperties":false},"example":{"wallet":"example","blockchainNamespace":"tezos","verified":true}}}},"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]},"blockchainNamespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"],"nullable":true},"customerId":{"type":"string","format":"uuid"},"verified":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","wallet","customerId","verified","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","blockchainNamespace":"tezos","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/wallets/{id}":{"delete":{"operationId":"individualsRouter-wallets-deleteIndividualWallet","summary":"Delete individual wallet","description":"Delete a individual's wallet.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/wallets/rescore/{id}":{"post":{"operationId":"individualsRouter-wallets-reScoreWallet","summary":"Re score individual wallet","description":"Re score a individual's wallet.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"example"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]},"blockchainNamespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"],"nullable":true},"customerId":{"type":"string","format":"uuid"},"verified":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","wallet","customerId","verified","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","blockchainNamespace":"tezos","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals":{"get":{"operationId":"individualsRouter-getIndividuals","summary":"Get individuals","description":"List individual customers in the workspace resolved from the API key, honoring the supplied filter/pagination parameters. Read-only.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"currentPage","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"number"}],"default":0},"example":0},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"number"}],"default":10},"example":10},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-05-14T09:30:00.000Z"},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-05-14T09:30:00.000Z"},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"]},"example":"Active"},{"name":"riskLevel","in":"query","required":false,"schema":{"type":"string","enum":["Low","Medium","High","No risk"]},"example":"Low"},{"name":"onBoardingLevel","in":"query","required":false,"schema":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded"]},"example":"Started"},{"name":"softDeletedBefore","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-05-14T09:30:00.000Z"},{"name":"search","in":"query","required":false,"schema":{"type":"string"},"example":"example"},{"name":"countryOfResidence","in":"query","required":false,"schema":{"type":"string","enum":["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"]},"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","example":"AFG"},{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["Individual","Company"]},"example":"Individual"},{"name":"externalCustomerId","in":"query","required":false,"schema":{"type":"string"},"example":"example"},{"name":"includeGhostRecords","in":"query","required":false,"schema":{"type":"boolean"},"example":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"filterCountries":{"type":"array","items":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)"}},"totalCount":{"type":"number"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"cms_project_id":{"type":"string"},"wallets":{"type":"array","items":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]}},"type":{"type":"string","enum":["Individual","Company"],"nullable":true},"country_of_residence":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"risk_score":{"type":"string","enum":["Low","Medium","High","No risk"],"nullable":true},"onboarding_level":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded","Onboarding","KYB","Onboarded"],"nullable":true},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"],"nullable":true},"date_onboarded":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"open_alerts_count":{"type":"number"},"name":{"type":"string","nullable":true},"tagsToEntity":{"type":"array","items":{"type":"object","properties":{"id":{},"tagId":{"type":"string"},"entityId":{"type":"string"},"entityType":{"type":"string","enum":["transactionReview","customer","alert","wallet"]},"createdBy":{"type":"string","nullable":true},"tags":{"type":"object","properties":{"id":{},"type":{"type":"string","enum":["transaction","individual","company","wallet"]},"title":{"type":"string"},"backgroundColor":{"type":"string"},"textColor":{"type":"string"},"workspaceId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"deletedAt":{"type":"string","format":"date-time","nullable":true},"createdBy":{"type":"string","nullable":true},"updatedBy":{"type":"string","nullable":true}},"required":["id","type","title","backgroundColor","textColor","workspaceId"],"additionalProperties":false}},"required":["id","tagId","entityId","entityType","tags"],"additionalProperties":false},"nullable":true}},"required":["id","cms_project_id","wallets","type","country_of_residence","risk_score","onboarding_level","status","date_onboarded","date_updated","open_alerts_count"],"additionalProperties":false}}},"required":["filterCountries","totalCount","data"],"additionalProperties":false},"example":{"filterCountries":["AFG"],"totalCount":42,"data":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","cms_project_id":"example","wallets":["example"],"type":"Individual","country_of_residence":"AFG","risk_score":"Low","onboarding_level":"Started","status":"Active","date_onboarded":"2024-05-14T09:30:00.000Z","date_updated":"2024-05-14T09:30:00.000Z","open_alerts_count":42,"name":"Jane Doe","tagsToEntity":[{"id":"tte_3b241101e2bb42558caf4136","tagId":"example","entityId":"example","entityType":"transactionReview","createdBy":"workspace","tags":{"id":"tag_3b241101e2bb42558caf4136","type":"transaction","title":"Example title","backgroundColor":"example","textColor":"example","workspaceId":"example","organizationId":"example","deletedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}]}]}}}},"default":{"$ref":"#/components/responses/error"}}},"post":{"operationId":"individualsRouter-createIndividual","summary":"Create a single individual","description":"Create a single individual customer in the workspace/organization resolved from the API key. `externalId` is your own stable identifier for the individual; the response returns the newly-created ComPilot `customerId` and the echoed `externalId`. Requires a workspace API key (401 UNAUTHORIZED otherwise). Use `/individuals/batch` to create many at once.","tags":["Individuals"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customerWallet":{"type":"object","properties":{"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]},"blockchainNamespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"],"nullable":true},"verified":{"type":"boolean","nullable":true},"createdBy":{"type":"string"}},"required":["wallet"],"additionalProperties":false},"customerClaims":{"type":"object","properties":{"sub":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"givenName":{"type":"string","nullable":true},"familyName":{"type":"string","nullable":true},"middleName":{"type":"string","nullable":true},"nickname":{"type":"string","nullable":true},"preferredUsername":{"type":"string","nullable":true},"profile":{"type":"string","nullable":true},"picture":{"type":"string","nullable":true},"pictureBase64":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"birthdate":{"type":"string","format":"date-time"},"zoneinfo":{"type":"string","nullable":true},"locale":{"type":"string","nullable":true},"countryOfResidence":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"nationality":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"createdBy":{"type":"string"}},"additionalProperties":false},"customerDid":{"type":"object","properties":{"did":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["did"],"additionalProperties":false},"externalId":{"type":"string"},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"]},"onboardingLevel":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded"]},"riskScore":{"type":"string","enum":["Low","Medium","High","No risk"]},"phoneNumber":{"type":"object","properties":{"phoneNumber":{"type":"string"},"verified":{"type":"boolean","nullable":true}},"required":["phoneNumber"],"additionalProperties":false},"email":{"type":"object","properties":{"email":{"type":"string","format":"email"},"verified":{"type":"boolean","nullable":true}},"required":["email"],"additionalProperties":false},"ipAddress":{"type":"string"},"createdBy":{"type":"string"}},"required":["createdBy"],"additionalProperties":false},"example":{"customerWallet":{"wallet":"example","blockchainNamespace":"tezos","verified":true,"createdBy":"workspace"},"customerClaims":{"sub":"example","name":"Jane Doe","givenName":"Jane Doe","familyName":"Jane Doe","middleName":"Jane Doe","nickname":"Jane Doe","preferredUsername":"Jane Doe","profile":"example","picture":"example","pictureBase64":"example","website":"example","gender":"example","birthdate":"2024-05-14T09:30:00.000Z","zoneinfo":"example","locale":"example","countryOfResidence":"AFG","nationality":"AFG","createdBy":"workspace"},"customerDid":{"did":"example","createdBy":"workspace","updatedBy":"workspace"},"externalId":"example","status":"Active","onboardingLevel":"Started","riskScore":"Low","phoneNumber":{"phoneNumber":"+4915112345678","verified":true},"email":{"email":"jane.doe@example.com","verified":true},"ipAddress":"203.0.113.42","createdBy":"workspace"}}}},"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"externalId":{"type":"string","nullable":true}},"required":["customerId"],"additionalProperties":false},"example":{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","externalId":"example"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}":{"get":{"operationId":"individualsRouter-getIndividual","summary":"Get single individual","description":"Fetch a single individual customer by its ComPilot customer id, scoped to the workspace resolved from the API key. Read-only; returns the core individual record. Use `/individuals/{customerId}/details` for the expanded detail graph.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"cmsProjectId":{"type":"string"},"workspaceId":{"type":"string","nullable":true},"organizationId":{"type":"string","nullable":true},"externalCustomerId":{"type":"string","nullable":true},"riskScore":{"type":"string","enum":["Low","Medium","High","No risk"],"nullable":true},"type":{"type":"string","enum":["Individual","Company"],"nullable":true},"onboardingLevel":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded","Onboarding","KYB","Onboarded"],"nullable":true},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"reason":{"type":"string","nullable":true},"customerId":{"type":"string","format":"uuid"}},"required":["cmsProjectId","workspaceId","organizationId","externalCustomerId","riskScore","type","onboardingLevel","status","createdAt","updatedAt","createdBy","updatedBy","customerId"],"additionalProperties":false},"example":{"cmsProjectId":"example","workspaceId":"example","organizationId":"example","externalCustomerId":"example","riskScore":"Low","type":"Individual","onboardingLevel":"Started","status":"Active","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","reason":"Manual review required","customerId":"3b241101-e2bb-4255-8caf-4136c566a962"}}}},"default":{"$ref":"#/components/responses/error"}}},"patch":{"operationId":"individualsRouter-updateIndividual","summary":"Update single individual","description":"Update a single individual.","tags":["Individuals"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"externalCustomerId":{"type":"string","nullable":true},"riskScore":{"type":"string","enum":["Low","Medium","High","No risk"],"nullable":true},"type":{"type":"string","enum":["Individual","Company"],"nullable":true},"onboardingLevel":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded","Onboarding","KYB","Onboarded"],"nullable":true},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"],"nullable":true},"reason":{"type":"string","nullable":true}},"additionalProperties":false},"example":{"externalCustomerId":"example","riskScore":"Low","type":"Individual","onboardingLevel":"Started","status":"Active","reason":"Manual review required"}}}},"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/details":{"get":{"operationId":"individualsRouter-getIndividualDetails","summary":"Get individual details by id","description":"Fetch a single individual customer together with its expanded detail graph by its ComPilot customer id, scoped to the workspace resolved from the API key. Read-only.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"cmsProjectId":{"type":"string"},"workspaceId":{"type":"string","nullable":true},"organizationId":{"type":"string","nullable":true},"externalCustomerId":{"type":"string","nullable":true},"riskScore":{"type":"string","enum":["Low","Medium","High","No risk"],"nullable":true},"type":{"type":"string","enum":["Individual","Company"],"nullable":true},"onboardingLevel":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded","Onboarding","KYB","Onboarded"],"nullable":true},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"reason":{"type":"string","nullable":true},"customerWallets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]},"blockchainNamespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"],"nullable":true},"customerId":{"type":"string","format":"uuid"},"verified":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"bigData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid","nullable":true},"wallet":{"type":"string"},"onchainData":{"anyOf":[{"type":"object","properties":{"error":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number","enum":[400]},"errorCode":{"type":"string","enum":["INVALID_ADDRESS"]},"message":{"type":"string","enum":["The address provided isn't a valid address."]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[401]},"errorCode":{"type":"string","enum":["API_KEY_NOT_FOUND"]},"message":{"type":"string","enum":["Your API key is not found."]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[403]},"errorCode":{"type":"string","enum":["API_KEY_ARCHIVED"]},"message":{"type":"string","enum":["Your API key is archived."]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[403]},"errorCode":{"type":"string","enum":["API_KEY_DISABLED"]},"message":{"type":"string","enum":["Your API key is disabled."]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[403]},"errorCode":{"type":"string","enum":["SOURCE_IP_NOT_EQ_API_KEY_IPS"]},"message":{"type":"string","enum":["Your source IP does not match the IPs for your API key."]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[500]},"errorCode":{"type":"string","enum":["INTERNAL_SERVER_ERROR"]},"message":{"type":"string","enum":["INTERNAL SERVER ERROR"]}},"required":["statusCode","errorCode","message"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","enum":[500]},"errorCode":{"type":"string","enum":["UNKNOWN_ERROR"]},"message":{"type":"string"}},"required":["statusCode","errorCode","message"],"additionalProperties":false,"description":"This is a fallback error, if bit rank parser fails"},{"type":"object","properties":{"statusCode":{"type":"number","enum":[500]},"errorCode":{"type":"string","enum":["RESULT_PARSER_ERROR"]},"message":{"type":"string"},"data":{"type":"string"}},"required":["statusCode","errorCode","message","data"],"additionalProperties":false,"description":"This is a fallback error, if zod parse fails on result"}]}},"required":["error"],"additionalProperties":false},{"type":"object","properties":{"label":{"type":"string"},"currency":{"type":"string"},"new_address":{"type":"boolean"},"score":{"type":"number"},"entities":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"type":{"type":"string"}},"required":["label","type"],"additionalProperties":false}},"flags":{"type":"array","items":{"type":"string"}},"flags_with_category":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"}},"required":["name","category"],"additionalProperties":false}},"cluster":{"type":"object","properties":{"cluster_name":{"type":"string"},"cluster_identifier":{"type":"number"},"number_of_addresses_in_cluster":{"type":"number"}},"required":["cluster_name","cluster_identifier","number_of_addresses_in_cluster"],"additionalProperties":false},"first_seen_receiving":{"type":"number"},"first_seen_sending":{"type":"number"},"last_seen_receiving":{"type":"number"},"last_seen_sending":{"type":"number"},"received_amount":{"type":"number"},"sent_amount":{"type":"number"},"number_of_transactions":{"type":"number"},"received_transactions":{"type":"number"},"sent_transactions":{"type":"number"},"balance":{"type":"number"},"balance_fiat":{"type":"object","properties":{"jpy":{"type":"number"},"eur":{"type":"number"},"usd":{"type":"number"},"cad":{"type":"number"}},"required":["jpy","eur","usd","cad"],"additionalProperties":false},"bitrank_counterparty_exposure":{"type":"object","properties":{"in":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["min","max","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false},"out":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["min","max","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false}},"required":["in","out"],"additionalProperties":false},"entity_counterparty_exposure":{"type":"object","properties":{"in":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["name","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false},"out":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["name","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false}},"required":["in","out"],"additionalProperties":false},"flag_counterparty_exposure":{"type":"object","properties":{"in":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["name","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false},"out":{"type":"object","properties":{"updatedAt":{"type":"number"},"totalVolume":{"type":"number"},"exposure":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"},"volume":{"type":"number"}},"required":["name","count","volume"],"additionalProperties":false}}},"required":["updatedAt","totalVolume","exposure"],"additionalProperties":false}},"required":["in","out"],"additionalProperties":false},"transactions":{"type":"array","items":{"type":"object","properties":{"hash":{"type":"string"},"amount":{"type":"number"},"fees":{"type":"number"}},"required":["hash","amount","fees"],"additionalProperties":false}}},"additionalProperties":false}]},"requestObject":{"type":"object","properties":{"crypto":{"type":"string","enum":["btc","eth","ltc","bch","xrp","xlm","sys","xdc","doge","dash","zec","trx","etc","bsc"],"default":"eth","nullable":true},"address":{"type":"string","nullable":true},"properties":{"type":"array","items":{"type":"object","properties":{"property":{"type":"string","enum":["score","entities","flags","currency","new_address","flags_with_category","cluster","first_seen_receiving","first_seen_sending","last_seen_receiving","last_seen_sending","received_amount","sent_amount","number_of_transactions","received_transactions","sent_transactions","balance","balance_fiat","bitrank_counterparty_exposure","entity_counterparty_exposure","flag_counterparty_exposure"]}},"required":["property"],"additionalProperties":false,"description":"A comma-separated list of properties that will determine if the property is in the response."},"description":"Optional query parameter to specify properties to include in the response.","default":[{"property":"score"},{"property":"entities"},{"property":"flags"},{"property":"currency"},{"property":"new_address"}],"nullable":true},"label":{"type":"string","maxLength":255,"description":"Optional string of up to 255 characters for labeling the search.","nullable":true},"transactionsPerPage":{"type":"number","description":"Optional parameter to specify the number of transactions per page in the response.","nullable":true}},"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","wallet","onchainData","requestObject","createdAt","updatedAt"],"additionalProperties":false},"nullable":true},"merkleScienceData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid","nullable":true},"wallet":{"type":"string"},"onchainData":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number","nullable":true},"identifier":{"type":"string","nullable":true},"blockchain":{"type":"integer","minimum":0,"maximum":123,"nullable":true},"blockchain_verbose":{"type":"string","enum":["Bitcoin","Ethereum","Litecoin","BitcoinCash","Ripple","Dogecoin","Zilliqa","BinanceSmartChain","Polygon","Tron","Cardano","Polkadot","Stellar","Hedera","Cronos","Optimism","Arbitrum","Fantom","Monero","Cosmos","Zcash","EthereumClassic","Dash","Solana","AvalancheC_Chain","Verge","BitcoinGold","Algorand","Acala","Akash","Arweave","Ardor","Ark","Astar","Band","BinanceNative","Celo","Chiliz","Nervos","CronosNative","Digibyte","Multiversx","Enjin","Eos","EthereumPow","FetchAI","Filecoin","Flow","Flare","Moonbeam","Helium","ICP","Icon","Injective","IOTA","IoTex","Iris","Kava","Kadena","Klaytn","Komodo","Kusama","Lisk","Terra","Mina","Moonriver","Nano","Near","Neo3","Oasys","One","Ontology","Osmosis","Polymesh","QTUM","Oasis","Thorchain","Ravencoin","Siacoin","Shiden","Songbird","Stratis","Stacks","SUI","zkSync","Theta","Tomo","VeChain","Waves","Wax","WEMIX","WaltonChain","Chia","Tezos","Zcoin","Celestia","Neutron","Avalanche_P","Sei","Avalanche_X","Aztec","Bittensor","Casper","Deso","Juno","PocketNetwork","Ronin","Vara","XPLA","Archway","Axelar","Dymension","Starknet","Orai","Lukso","bitsCrunch","Reef","ImmutablezkEVM","BaseProtocol","ArbitrumNova","Canto","MetisDAO","Aptos","Bitcoin Cash","Binance Smart Chain","Ethereum Classic","Avalanche C-Chain","Bitcoin Gold","Binance Native","Cronos Native","Ethereum Pow","Fetch AI","Avalanche-P","Avalanche-X","Pocket Network","Immutable zkEVM","Base Protocol","Arbitrum Nova"],"nullable":true},"customer_id":{"type":"string","format":"uuid","nullable":true},"type":{"type":"number","nullable":true},"type_verbose":{"type":"string","nullable":true},"total_incoming_value":{"type":"string","nullable":true},"total_incoming_value_usd":{"type":"string","nullable":true},"total_outgoing_value":{"type":"string","nullable":true},"total_outgoing_value_usd":{"type":"string","nullable":true},"balance":{"type":"number","nullable":true},"earliest_transaction_time":{"type":"string","nullable":true},"latest_transaction_time":{"type":"string","nullable":true},"risk_level":{"type":"integer","minimum":0,"maximum":5,"nullable":true},"risk_level_verbose":{"type":"string","enum":["No Risk Detected","Info","Caution","Medium","High","Critical"],"nullable":true},"created_at":{"type":"string","nullable":true},"updated_at":{"type":"string","nullable":true},"originator":{"type":"array","items":{"type":"object","properties":{"tag_type_verbose":{"type":"string"},"tag_subtype_verbose":{"type":"string"},"tag_name_verbose":{"type":"string"},"total_value_usd":{"type":"number"},"exposure_type":{"type":"string"}},"required":["tag_type_verbose","tag_subtype_verbose","tag_name_verbose","total_value_usd","exposure_type"],"additionalProperties":false},"nullable":true},"beneficiary":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":false},"nullable":true},"tags":{"type":"object","properties":{"owner":{"type":"object","properties":{"tag_type_verbose":{"type":"string","nullable":true},"tag_subtype_verbose":{"type":"string","nullable":true},"tag_name_verbose":{"type":"string","nullable":true}},"additionalProperties":false},"user":{"type":"object","properties":{"tag_type_verbose":{"type":"string","nullable":true},"tag_subtype_verbose":{"type":"string","nullable":true},"tag_name_verbose":{"type":"string","nullable":true}},"additionalProperties":false}},"required":["owner","user"],"additionalProperties":false,"nullable":true},"custom_tags":{"type":"array","items":{"type":"string"},"nullable":true},"digital_assets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true},"symbol":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false},{"type":"object","properties":{"error":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"},"data":{"type":"string","nullable":true}},"required":["error","message"],"additionalProperties":false},"risk_level":{"type":"integer","minimum":0,"maximum":5,"nullable":true},"risk_level_verbose":{"type":"string","enum":["No Risk Detected","Info","Caution","Medium","High","Critical"],"nullable":true},"identifier":{"type":"string","nullable":true}},"required":["error"],"additionalProperties":false}]},"requestObject":{"type":"object","properties":{"identifier":{"type":"string"},"blockchain":{"type":"string","enum":["0","1","2","3","4","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31","32","33","34","35","36","37","38","39","40","41","42","43","44","45","46","47","48","49","50","51","52","53","54","55","56","57","58","59","60","61","62","63","64","65","66","67","68","69","70","71","72","73","74","75","76","77","78","79","80","81","82","83","84","85","86","87","88","89","90","91","92","93","94","95","96","97","98","99","100","101","102","103","104","106","107","108","109","110","111","112","113","114","115","116","117","118","119","120","121","122","123"]},"customer_id":{"type":"string","format":"uuid"},"type":{"type":"number","enum":[1,2]},"show_alerts":{"type":"boolean","nullable":true},"custom_tags":{"type":"array","items":{"type":"string"},"nullable":true}},"required":["identifier","blockchain","type"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","wallet","onchainData","requestObject","createdAt","updatedAt"],"additionalProperties":false},"nullable":true},"chainalysisData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"wallet":{"type":"string"},"onchainData":{"anyOf":[{"type":"object","properties":{"address":{"type":"string"},"risk":{"type":"string","enum":["Severe","High","Medium","Low"]},"riskReason":{"type":"string","nullable":true},"cluster":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string"}},"required":["name","category"],"additionalProperties":false,"nullable":true},"addressType":{"type":"string","enum":["PRIVATE_WALLET","LIQUIDITY_POOL","SERVICE_PROVIDER"]},"addressIdentifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"url":{"type":"string","nullable":true},"createdAt":{"type":"number"}},"required":["name","address","category","description","createdAt"],"additionalProperties":false}},"exposures":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"value":{"type":"number"},"exposureType":{"type":"string","enum":["direct","indirect"]},"direction":{"type":"string","enum":["both_directions"]}},"required":["category","value","exposureType","direction"],"additionalProperties":false},"nullable":true},"triggers":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"percentage":{"type":"number"},"message":{"type":"string"},"ruleTriggered":{"type":"object","properties":{"risk":{"type":"string"},"minThreshold":{"type":"number"},"maxThreshold":{"type":"number"},"exposureType":{"type":"string","enum":["direct","indirect"]},"direction":{"type":"string","enum":["both_directions"]}},"required":["risk","minThreshold","maxThreshold","exposureType","direction"],"additionalProperties":false,"nullable":true}},"required":["category","percentage","message"],"additionalProperties":false},"nullable":true},"status":{"type":"string","enum":["COMPLETE"]},"poolMetadata":{"type":"object","properties":{"fees":{"type":"number","nullable":true},"tokens":{"type":"array","items":{"type":"string"}}},"required":["tokens"],"additionalProperties":false,"nullable":true}},"required":["address","risk","addressType","addressIdentifications","status"],"additionalProperties":false},{"type":"object","properties":{"statusCode":{"type":"number","nullable":true},"error":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"},"data":{"type":"string","nullable":true}},"required":["error","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}]},"requestObject":{"type":"object","properties":{"address":{"type":"string"}},"required":["address"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","wallet","onchainData","requestObject","createdAt","updatedAt"],"additionalProperties":false},"nullable":true}},"required":["id","wallet","customerId","verified","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"customerClaims":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"sub":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"givenName":{"type":"string","nullable":true},"familyName":{"type":"string","nullable":true},"middleName":{"type":"string","nullable":true},"nickname":{"type":"string","nullable":true},"preferredUsername":{"type":"string","nullable":true},"profile":{"type":"string","nullable":true},"picture":{"type":"string","nullable":true},"pictureBase64":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"birthdate":{"type":"string","format":"date-time","nullable":true},"zoneinfo":{"type":"string","nullable":true},"locale":{"type":"string","nullable":true},"countryOfResidence":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"nationality":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"updatedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","sub","name","givenName","familyName","middleName","nickname","preferredUsername","profile","picture","pictureBase64","website","gender","zoneinfo","locale","createdAt","createdBy","updatedBy"],"additionalProperties":false}},"customerDids":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"did":{"type":"string"},"customerId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","did","customerId","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"customerAddresses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"formatted":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","formatted","street","city","state","region","postalCode","locality","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"customerIps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"ipAddress":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"ipQualityScoreData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"scoreAnalysis":{"anyOf":[{"type":"object","properties":{"error":{"anyOf":[{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string","enum":["Invalid or unauthorized key. Please check the API key and try again."]},"request_id":{"type":"string"}},"required":["success","message","request_id"],"additionalProperties":false},{"type":"object","properties":{"error":{"type":"string","enum":["UNKNOWN_ERROR"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false,"description":"This is a fallback error, if IPQualityScore parser fails"},{"type":"object","properties":{"error":{"type":"string","enum":["RESULT_PARSER_ERROR"]},"message":{"type":"string"},"data":{"type":"string"}},"required":["error","message","data"],"additionalProperties":false,"description":"This is a fallback error, if zod parse fails on result"}]}},"required":["error"],"additionalProperties":false},{"type":"object","properties":{"ipVerification":{"type":"object","properties":{"success":{"type":"boolean"},"request_id":{"type":"string"},"message":{"type":"string","nullable":true},"fraud_score":{"type":"integer","minimum":0,"maximum":100,"nullable":true},"country_code":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"ISP":{"type":"string","nullable":true},"ASN":{"type":"number","nullable":true},"organization":{"type":"string","nullable":true},"is_crawler":{"type":"boolean","nullable":true},"timezone":{"type":"string","nullable":true},"mobile":{"type":"boolean","nullable":true},"host":{"type":"string","nullable":true},"proxy":{"type":"boolean","nullable":true},"vpn":{"type":"boolean","nullable":true},"tor":{"type":"boolean","nullable":true},"active_vpn":{"type":"boolean","nullable":true},"active_tor":{"type":"boolean","nullable":true},"recent_abuse":{"type":"boolean","nullable":true},"bot_status":{"type":"boolean","nullable":true},"connection_type":{"type":"string","nullable":true},"abuse_velocity":{"type":"string","nullable":true},"zip_code":{"type":"string","nullable":true},"latitude":{"type":"number","nullable":true},"longitude":{"type":"number","nullable":true}},"required":["success","request_id"],"additionalProperties":false,"nullable":true},"emailVerification":{"type":"object","properties":{"success":{"type":"boolean"},"request_id":{"type":"string"},"message":{"type":"string","nullable":true},"valid":{"type":"boolean","nullable":true},"timed_out":{"type":"boolean","nullable":true},"disposable":{"type":"boolean","nullable":true},"first_name":{"type":"string","nullable":true},"deliverability":{"type":"string","nullable":true},"smtp_score":{"type":"number","nullable":true},"overall_score":{"type":"number","nullable":true},"catch_all":{"type":"boolean","nullable":true},"generic":{"type":"boolean","nullable":true},"common":{"type":"boolean","nullable":true},"dns_valid":{"type":"boolean","nullable":true},"honeypot":{"type":"boolean","nullable":true},"frequent_complainer":{"type":"boolean","nullable":true},"suspect":{"type":"boolean","nullable":true},"recent_abuse":{"type":"boolean","nullable":true},"fraud_score":{"type":"number","minimum":0,"maximum":100,"nullable":true},"leaked":{"type":"boolean","nullable":true},"suggested_domain":{"type":"string","nullable":true},"domain_velocity":{"type":"string","nullable":true},"user_activity":{"type":"string","nullable":true},"associated_names":{"type":"object","properties":{"status":{"type":"string","nullable":true},"names":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"nullable":true},"associated_phone_numbers":{"type":"object","properties":{"status":{"type":"string","nullable":true},"phone_numbers":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"nullable":true},"first_seen":{"type":"object","properties":{"human":{"type":"string","nullable":true},"timestamp":{"type":"number","nullable":true},"iso":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"domain_age":{"type":"object","properties":{"human":{"type":"string","nullable":true},"timestamp":{"type":"number","nullable":true},"iso":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"spam_trap_score":{"type":"string","nullable":true},"sanitized_email":{"type":"string","nullable":true}},"required":["success","request_id"],"additionalProperties":false,"nullable":true},"phoneVerification":{"type":"object","properties":{"success":{"type":"boolean"},"request_id":{"type":"string"},"message":{"type":"string","nullable":true},"formatted":{"type":"string","nullable":true},"local_format":{"type":"string","nullable":true},"valid":{"type":"boolean","nullable":true},"fraud_score":{"type":"number","minimum":0,"maximum":100,"nullable":true},"recent_abuse":{"type":"boolean","nullable":true},"VOIP":{"type":"boolean","nullable":true},"prepaid":{"type":"boolean","nullable":true},"risky":{"type":"boolean","nullable":true},"active":{"type":"boolean","nullable":true},"name":{"type":"string","nullable":true},"carrier":{"type":"string","nullable":true},"line_type":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true},"zip_code":{"type":"string","nullable":true},"dialing_code":{"type":"number","nullable":true},"do_not_call":{"type":"boolean","nullable":true},"leaked":{"type":"boolean","nullable":true},"spammer":{"type":"boolean","nullable":true},"active_status":{"type":"string","nullable":true},"user_activity":{"type":"string","nullable":true},"associated_email_addresses":{"type":"object","properties":{"status":{"type":"string","nullable":true},"emails":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"nullable":true}},"required":["success","request_id"],"additionalProperties":false,"nullable":true},"error":{"type":"string","nullable":true}},"additionalProperties":false}]},"requestObject":{"type":"object","properties":{"apiKey":{"type":"string","nullable":true},"ipValue":{"type":"string","nullable":true},"userEmail":{"type":"string","nullable":true},"userPhoneNumber":{"type":"string","nullable":true}},"additionalProperties":false},"ipValue":{"type":"string","nullable":true},"userEmail":{"type":"string","nullable":true},"userPhoneNumber":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","scoreAnalysis","requestObject","ipValue","userEmail","userPhoneNumber","createdAt","updatedAt"],"additionalProperties":false},"nullable":true}},"required":["id","customerId","ipAddress","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"customerPhones":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"phoneNumber":{"type":"string"},"verified":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"ipQualityScoreData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"scoreAnalysis":{"anyOf":[{"type":"object","properties":{"error":{"anyOf":[{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string","enum":["Invalid or unauthorized key. Please check the API key and try again."]},"request_id":{"type":"string"}},"required":["success","message","request_id"],"additionalProperties":false},{"type":"object","properties":{"error":{"type":"string","enum":["UNKNOWN_ERROR"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false,"description":"This is a fallback error, if IPQualityScore parser fails"},{"type":"object","properties":{"error":{"type":"string","enum":["RESULT_PARSER_ERROR"]},"message":{"type":"string"},"data":{"type":"string"}},"required":["error","message","data"],"additionalProperties":false,"description":"This is a fallback error, if zod parse fails on result"}]}},"required":["error"],"additionalProperties":false},{"type":"object","properties":{"ipVerification":{"type":"object","properties":{"success":{"type":"boolean"},"request_id":{"type":"string"},"message":{"type":"string","nullable":true},"fraud_score":{"type":"integer","minimum":0,"maximum":100,"nullable":true},"country_code":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"ISP":{"type":"string","nullable":true},"ASN":{"type":"number","nullable":true},"organization":{"type":"string","nullable":true},"is_crawler":{"type":"boolean","nullable":true},"timezone":{"type":"string","nullable":true},"mobile":{"type":"boolean","nullable":true},"host":{"type":"string","nullable":true},"proxy":{"type":"boolean","nullable":true},"vpn":{"type":"boolean","nullable":true},"tor":{"type":"boolean","nullable":true},"active_vpn":{"type":"boolean","nullable":true},"active_tor":{"type":"boolean","nullable":true},"recent_abuse":{"type":"boolean","nullable":true},"bot_status":{"type":"boolean","nullable":true},"connection_type":{"type":"string","nullable":true},"abuse_velocity":{"type":"string","nullable":true},"zip_code":{"type":"string","nullable":true},"latitude":{"type":"number","nullable":true},"longitude":{"type":"number","nullable":true}},"required":["success","request_id"],"additionalProperties":false,"nullable":true},"emailVerification":{"type":"object","properties":{"success":{"type":"boolean"},"request_id":{"type":"string"},"message":{"type":"string","nullable":true},"valid":{"type":"boolean","nullable":true},"timed_out":{"type":"boolean","nullable":true},"disposable":{"type":"boolean","nullable":true},"first_name":{"type":"string","nullable":true},"deliverability":{"type":"string","nullable":true},"smtp_score":{"type":"number","nullable":true},"overall_score":{"type":"number","nullable":true},"catch_all":{"type":"boolean","nullable":true},"generic":{"type":"boolean","nullable":true},"common":{"type":"boolean","nullable":true},"dns_valid":{"type":"boolean","nullable":true},"honeypot":{"type":"boolean","nullable":true},"frequent_complainer":{"type":"boolean","nullable":true},"suspect":{"type":"boolean","nullable":true},"recent_abuse":{"type":"boolean","nullable":true},"fraud_score":{"type":"number","minimum":0,"maximum":100,"nullable":true},"leaked":{"type":"boolean","nullable":true},"suggested_domain":{"type":"string","nullable":true},"domain_velocity":{"type":"string","nullable":true},"user_activity":{"type":"string","nullable":true},"associated_names":{"type":"object","properties":{"status":{"type":"string","nullable":true},"names":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"nullable":true},"associated_phone_numbers":{"type":"object","properties":{"status":{"type":"string","nullable":true},"phone_numbers":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"nullable":true},"first_seen":{"type":"object","properties":{"human":{"type":"string","nullable":true},"timestamp":{"type":"number","nullable":true},"iso":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"domain_age":{"type":"object","properties":{"human":{"type":"string","nullable":true},"timestamp":{"type":"number","nullable":true},"iso":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"spam_trap_score":{"type":"string","nullable":true},"sanitized_email":{"type":"string","nullable":true}},"required":["success","request_id"],"additionalProperties":false,"nullable":true},"phoneVerification":{"type":"object","properties":{"success":{"type":"boolean"},"request_id":{"type":"string"},"message":{"type":"string","nullable":true},"formatted":{"type":"string","nullable":true},"local_format":{"type":"string","nullable":true},"valid":{"type":"boolean","nullable":true},"fraud_score":{"type":"number","minimum":0,"maximum":100,"nullable":true},"recent_abuse":{"type":"boolean","nullable":true},"VOIP":{"type":"boolean","nullable":true},"prepaid":{"type":"boolean","nullable":true},"risky":{"type":"boolean","nullable":true},"active":{"type":"boolean","nullable":true},"name":{"type":"string","nullable":true},"carrier":{"type":"string","nullable":true},"line_type":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true},"zip_code":{"type":"string","nullable":true},"dialing_code":{"type":"number","nullable":true},"do_not_call":{"type":"boolean","nullable":true},"leaked":{"type":"boolean","nullable":true},"spammer":{"type":"boolean","nullable":true},"active_status":{"type":"string","nullable":true},"user_activity":{"type":"string","nullable":true},"associated_email_addresses":{"type":"object","properties":{"status":{"type":"string","nullable":true},"emails":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"nullable":true}},"required":["success","request_id"],"additionalProperties":false,"nullable":true},"error":{"type":"string","nullable":true}},"additionalProperties":false}]},"requestObject":{"type":"object","properties":{"apiKey":{"type":"string","nullable":true},"ipValue":{"type":"string","nullable":true},"userEmail":{"type":"string","nullable":true},"userPhoneNumber":{"type":"string","nullable":true}},"additionalProperties":false},"ipValue":{"type":"string","nullable":true},"userEmail":{"type":"string","nullable":true},"userPhoneNumber":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","scoreAnalysis","requestObject","ipValue","userEmail","userPhoneNumber","createdAt","updatedAt"],"additionalProperties":false},"nullable":true}},"required":["id","customerId","phoneNumber","verified","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"customerEmails":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"email":{"type":"string"},"verified":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"ipQualityScoreData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"scoreAnalysis":{"anyOf":[{"type":"object","properties":{"error":{"anyOf":[{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string","enum":["Invalid or unauthorized key. Please check the API key and try again."]},"request_id":{"type":"string"}},"required":["success","message","request_id"],"additionalProperties":false},{"type":"object","properties":{"error":{"type":"string","enum":["UNKNOWN_ERROR"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false,"description":"This is a fallback error, if IPQualityScore parser fails"},{"type":"object","properties":{"error":{"type":"string","enum":["RESULT_PARSER_ERROR"]},"message":{"type":"string"},"data":{"type":"string"}},"required":["error","message","data"],"additionalProperties":false,"description":"This is a fallback error, if zod parse fails on result"}]}},"required":["error"],"additionalProperties":false},{"type":"object","properties":{"ipVerification":{"type":"object","properties":{"success":{"type":"boolean"},"request_id":{"type":"string"},"message":{"type":"string","nullable":true},"fraud_score":{"type":"integer","minimum":0,"maximum":100,"nullable":true},"country_code":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"ISP":{"type":"string","nullable":true},"ASN":{"type":"number","nullable":true},"organization":{"type":"string","nullable":true},"is_crawler":{"type":"boolean","nullable":true},"timezone":{"type":"string","nullable":true},"mobile":{"type":"boolean","nullable":true},"host":{"type":"string","nullable":true},"proxy":{"type":"boolean","nullable":true},"vpn":{"type":"boolean","nullable":true},"tor":{"type":"boolean","nullable":true},"active_vpn":{"type":"boolean","nullable":true},"active_tor":{"type":"boolean","nullable":true},"recent_abuse":{"type":"boolean","nullable":true},"bot_status":{"type":"boolean","nullable":true},"connection_type":{"type":"string","nullable":true},"abuse_velocity":{"type":"string","nullable":true},"zip_code":{"type":"string","nullable":true},"latitude":{"type":"number","nullable":true},"longitude":{"type":"number","nullable":true}},"required":["success","request_id"],"additionalProperties":false,"nullable":true},"emailVerification":{"type":"object","properties":{"success":{"type":"boolean"},"request_id":{"type":"string"},"message":{"type":"string","nullable":true},"valid":{"type":"boolean","nullable":true},"timed_out":{"type":"boolean","nullable":true},"disposable":{"type":"boolean","nullable":true},"first_name":{"type":"string","nullable":true},"deliverability":{"type":"string","nullable":true},"smtp_score":{"type":"number","nullable":true},"overall_score":{"type":"number","nullable":true},"catch_all":{"type":"boolean","nullable":true},"generic":{"type":"boolean","nullable":true},"common":{"type":"boolean","nullable":true},"dns_valid":{"type":"boolean","nullable":true},"honeypot":{"type":"boolean","nullable":true},"frequent_complainer":{"type":"boolean","nullable":true},"suspect":{"type":"boolean","nullable":true},"recent_abuse":{"type":"boolean","nullable":true},"fraud_score":{"type":"number","minimum":0,"maximum":100,"nullable":true},"leaked":{"type":"boolean","nullable":true},"suggested_domain":{"type":"string","nullable":true},"domain_velocity":{"type":"string","nullable":true},"user_activity":{"type":"string","nullable":true},"associated_names":{"type":"object","properties":{"status":{"type":"string","nullable":true},"names":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"nullable":true},"associated_phone_numbers":{"type":"object","properties":{"status":{"type":"string","nullable":true},"phone_numbers":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"nullable":true},"first_seen":{"type":"object","properties":{"human":{"type":"string","nullable":true},"timestamp":{"type":"number","nullable":true},"iso":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"domain_age":{"type":"object","properties":{"human":{"type":"string","nullable":true},"timestamp":{"type":"number","nullable":true},"iso":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"spam_trap_score":{"type":"string","nullable":true},"sanitized_email":{"type":"string","nullable":true}},"required":["success","request_id"],"additionalProperties":false,"nullable":true},"phoneVerification":{"type":"object","properties":{"success":{"type":"boolean"},"request_id":{"type":"string"},"message":{"type":"string","nullable":true},"formatted":{"type":"string","nullable":true},"local_format":{"type":"string","nullable":true},"valid":{"type":"boolean","nullable":true},"fraud_score":{"type":"number","minimum":0,"maximum":100,"nullable":true},"recent_abuse":{"type":"boolean","nullable":true},"VOIP":{"type":"boolean","nullable":true},"prepaid":{"type":"boolean","nullable":true},"risky":{"type":"boolean","nullable":true},"active":{"type":"boolean","nullable":true},"name":{"type":"string","nullable":true},"carrier":{"type":"string","nullable":true},"line_type":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true},"zip_code":{"type":"string","nullable":true},"dialing_code":{"type":"number","nullable":true},"do_not_call":{"type":"boolean","nullable":true},"leaked":{"type":"boolean","nullable":true},"spammer":{"type":"boolean","nullable":true},"active_status":{"type":"string","nullable":true},"user_activity":{"type":"string","nullable":true},"associated_email_addresses":{"type":"object","properties":{"status":{"type":"string","nullable":true},"emails":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"nullable":true}},"required":["success","request_id"],"additionalProperties":false,"nullable":true},"error":{"type":"string","nullable":true}},"additionalProperties":false}]},"requestObject":{"type":"object","properties":{"apiKey":{"type":"string","nullable":true},"ipValue":{"type":"string","nullable":true},"userEmail":{"type":"string","nullable":true},"userPhoneNumber":{"type":"string","nullable":true}},"additionalProperties":false},"ipValue":{"type":"string","nullable":true},"userEmail":{"type":"string","nullable":true},"userPhoneNumber":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","scoreAnalysis","requestObject","ipValue","userEmail","userPhoneNumber","createdAt","updatedAt"],"additionalProperties":false},"nullable":true}},"required":["id","customerId","email","verified","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"customerContactInformation":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"information":{"type":"object","properties":{"email":{"type":"string","format":"email"},"phone":{"type":"string","minLength":4,"maxLength":32},"twitter":{"type":"string"},"discord":{"type":"string"},"telegram":{"type":"string"}},"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["id","customerId","information","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false},"nullable":true},"customerDuplicates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerIdLeft":{"type":"string","format":"uuid"},"customerIdRight":{"type":"string","format":"uuid"},"description":{"type":"string","nullable":true},"customerInfoLeft":{"type":"string","nullable":true},"customerInfoRight":{"type":"string","nullable":true},"matchedFields":{"type":"string","nullable":true},"exactMatch":{"type":"boolean","nullable":true},"alertId":{"type":"string","format":"uuid","nullable":true},"workflowSessionId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerIdLeft","customerIdRight","description","customerInfoLeft","customerInfoRight","matchedFields","exactMatch","alertId","workflowSessionId","createdAt","updatedAt"],"additionalProperties":false},"nullable":true},"synapsSessions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"synapsSessionId":{"type":"string"},"customerId":{"type":"string","format":"uuid"},"sessionData":{"type":"object","properties":{"app":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}},"required":["name","id"],"additionalProperties":false},"session":{"type":"object","properties":{"alias":{"type":"string"},"id":{"type":"string"},"status":{"type":"string","enum":["APPROVED","SUBMISSION_REQUIRED","RESUBMISSION_REQUIRED","REJECTED","PENDING_VERIFICATION"]},"sandbox":{"type":"boolean"}},"required":["alias","id","status","sandbox"],"additionalProperties":false}},"required":["app","session"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"synapsSteps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"synapsStepId":{"type":"string"},"customerId":{"type":"string","format":"uuid"},"sessionId":{"type":"string","format":"uuid"},"stepData":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["ID_DOCUMENT","LIVENESS","PROOF_OF_ADDRESS","PHONE","EMAIL"]},"metadata":{"type":"object","properties":{"ip":{"type":"string"},"user_agent":{"type":"string"},"platform":{"type":"string"},"browser_name":{"type":"string"},"browser_version":{"type":"string"},"device":{"type":"string"},"customer_language":{"type":"string"}},"required":["ip","user_agent","platform","browser_name","browser_version","device","customer_language"],"additionalProperties":false},"status":{"type":"string","enum":["APPROVED","SUBMISSION_REQUIRED","RESUBMISSION_REQUIRED","REJECTED","PENDING_VERIFICATION"]},"reason":{"type":"object","properties":{"code":{"type":"string","enum":["FORGED_REJECTION","DOCUMENT_HIDDEN","BAD_ENVIRONMENT","BLACK_WHITE_PICTURE","BAD_QUALITY","DOCUMENT_COMPLIANCE","IDENTITY_DOCUMENT_EXPIRED","DOCUMENT_INVALID_FRONT_SIDE","DOCUMENT_INVALID_BACK_SIDE","IDENTITY_DOCUMENT_DOB_DATE_MINOR","RESTRICTED_NATIONALITY_TYPE","DUPLICATE_USER",""]},"message":{"type":"object","properties":{"original":{"type":"string"},"translated":{"type":"string"}},"required":["original","translated"],"additionalProperties":false}},"required":["code","message"],"additionalProperties":false,"nullable":true},"document":{"anyOf":[{"type":"object","properties":{"country":{"type":"string"},"type":{"type":"string","enum":["PASSPORT","NATIONAL_ID","DRIVER_LICENSE","RESIDENT_PERMIT",""]},"fields":{"type":"object","properties":{"firstname":{"type":"string"},"lastname":{"type":"string"},"birth_date":{"type":"string"},"document_expiration":{"type":"string"},"document_number":{"type":"string"},"nationality":{"type":"string"}},"required":["firstname","lastname","birth_date","document_expiration","document_number","nationality"],"additionalProperties":false},"files":{"type":"object","properties":{"front":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"size":{"type":"number"},"base64":{"type":"string","nullable":true}},"required":["url","type","size"],"additionalProperties":false,"nullable":true},"back":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"size":{"type":"number"},"base64":{"type":"string","nullable":true}},"required":["url","type","size"],"additionalProperties":false,"nullable":true},"face":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"size":{"type":"number"},"base64":{"type":"string","nullable":true}},"required":["url","type","size"],"additionalProperties":false,"nullable":true}},"additionalProperties":false},"original_files":{"type":"object","properties":{"front":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"size":{"type":"number"},"base64":{"type":"string","nullable":true}},"required":["url","type","size"],"additionalProperties":false,"nullable":true},"back":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"size":{"type":"number"},"base64":{"type":"string","nullable":true}},"required":["url","type","size"],"additionalProperties":false,"nullable":true}},"additionalProperties":false}},"required":["country","type","fields","files","original_files"],"additionalProperties":false},{"type":"object","properties":{"country":{"type":"string"},"type":{"type":"string","enum":["ELECTRICITY_BILL","INTERNET_BILL","LANDLINE_BILL","WATER_BILL","GAS_BILL","BANK_STATEMENT"]},"host_id_document":{"type":"object","properties":{},"additionalProperties":false},"files":{"type":"object","properties":{"proof":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"size":{"type":"number"},"base64":{"type":"string","nullable":true}},"required":["url","type","size"],"additionalProperties":false,"nullable":true},"accomodation":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"size":{"type":"number"},"base64":{"type":"string","nullable":true}},"required":["url","type","size"],"additionalProperties":false,"nullable":true}},"additionalProperties":false},"original_files":{"type":"object","properties":{"proof":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"size":{"type":"number"},"base64":{"type":"string","nullable":true}},"required":["url","type","size"],"additionalProperties":false,"nullable":true},"accomodation":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"size":{"type":"number"},"base64":{"type":"string","nullable":true}},"required":["url","type","size"],"additionalProperties":false,"nullable":true}},"additionalProperties":false},"fields":{"type":"object","properties":{"address":{"type":"string"},"city":{"type":"string"},"zipcode":{"type":"string"},"issuing_date":{"type":"string"}},"required":["address","city","zipcode","issuing_date"],"additionalProperties":false}},"required":["country","type","host_id_document","files","original_files","fields"],"additionalProperties":false}],"nullable":true},"verification":{"anyOf":[{"type":"object","properties":{"liveness":{"type":"object","properties":{"file":{"type":"object","properties":{"url":{"type":"string"},"type":{"type":"string"},"size":{"type":"number"},"base64":{"type":"string","nullable":true}},"required":["url","type","size"],"additionalProperties":false}},"required":["file"],"additionalProperties":false}},"required":["liveness"],"additionalProperties":false},{"type":"object","properties":{"phone":{"type":"object","properties":{"number":{"type":"string"},"calling_code":{"type":"string"},"method":{"type":"string"},"country":{"type":"string"}},"required":["number","calling_code","method","country"],"additionalProperties":false}},"required":["phone"],"additionalProperties":false},{"type":"object","properties":{"email":{"type":"object","properties":{"value":{"type":"string","format":"email"}},"required":["value"],"additionalProperties":false}},"required":["email"],"additionalProperties":false},{"type":"object","properties":{"aml":{"type":"object","properties":{"customer_info":{"type":"object","properties":{"firstname":{"type":"string"},"lastname":{"type":"string"},"birth_date":{"type":"string"},"nationality":{"type":"string"},"country":{"type":"string"}},"required":["firstname","lastname","birth_date","nationality","country"],"additionalProperties":false},"hits":{"type":"array","items":{"type":"object","properties":{"fields":{"type":"array","items":{}},"aliases":{"type":"array","items":{"type":"string"}},"media":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"snippet":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"}},"required":["date","snippet","title","url"],"additionalProperties":false}},"info":{"type":"object","properties":{"full_name":{"type":"string"},"birth_date":{"type":"string"},"nationality":{"type":"string"}},"required":["full_name","birth_date","nationality"],"additionalProperties":false},"type":{"type":"array","items":{"type":"string"}}},"required":["fields","aliases","media","info","type"],"additionalProperties":false}},"total_hits":{"type":"number"},"action_required":{"type":"boolean"},"monitored":{"type":"boolean"}},"required":["customer_info","hits","total_hits","action_required","monitored"],"additionalProperties":false}},"required":["aml"],"additionalProperties":false}],"nullable":true}},"required":["id","type","metadata","status"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","synapsStepId","customerId","sessionId","stepData","createdAt","updatedAt"],"additionalProperties":false}}},"required":["id","synapsSessionId","customerId","sessionData","createdAt","updatedAt","synapsSteps"],"additionalProperties":false}},"audits":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"action":{"type":"string","enum":["create","update","delete","attach","detach","duplicate"]},"author":{"type":"string","nullable":true},"record":{"anyOf":[{"type":"object","properties":{"tagId":{"type":"string"},"entityId":{"type":"string"},"entityType":{"type":"string","enum":["transactionReview","customer","alert","wallet"]},"tagTitle":{"type":"string"}},"required":["tagId","entityId","entityType"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"cmsProjectId":{"type":"string"},"workspaceId":{"type":"string","nullable":true},"organizationId":{"type":"string","nullable":true},"externalCustomerId":{"type":"string","nullable":true},"riskScore":{"type":"string","enum":["Low","Medium","High","No risk"],"nullable":true},"type":{"type":"string","enum":["Individual","Company"],"nullable":true},"onboardingLevel":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded","Onboarding","KYB","Onboarded"],"nullable":true},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"],"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"reason":{"type":"string","nullable":true}},"additionalProperties":false}]}},"required":["timestamp","action","record"],"additionalProperties":false}},"complyAdvantageSearches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid","nullable":true},"searchId":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"nullable":true},"searchRef":{"type":"string","nullable":true},"searchResult":{"type":"object","properties":{"client_ref":{"type":"string"},"id":{"type":"number"},"ref":{"type":"string"},"searcher_id":{"type":"number"},"assignee_id":{"type":"number"},"filters":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]},"nullable":true},"birth_year":{"type":"number","nullable":true},"remove_deceased":{"type":"number","minimum":0,"maximum":1,"nullable":true},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"],"nullable":true},"country_codes":{"type":"array","items":{"type":"string","enum":["AN","XK","AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"nullable":true}},"additionalProperties":false},"match_status":{"type":"string","enum":["unknown","no_match","potential_match","false_positive","true_positive","true_positive_approve","true_positive_reject"]},"risk_level":{"type":"string","enum":["low","medium","high","unknown"]},"search_term":{"type":"string"},"submitted_term":{"type":"string"},"total_hits":{"type":"number"},"total_matches":{"type":"number"},"total_blacklist_hits":{"type":"number"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"tags":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"labels":{"type":"array","items":{}},"limit":{"type":"number"},"offset":{"type":"number"},"searcher":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string","format":"email"},"name":{"type":"string"},"phone":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"user_is_active":{"type":"boolean"}},"required":["id","email","name","phone","created_at","user_is_active"],"additionalProperties":false},"assignee":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string","format":"email"},"name":{"type":"string"},"phone":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"user_is_active":{"type":"boolean"}},"required":["id","email","name","phone","created_at","user_is_active"],"additionalProperties":false},"hits":{"type":"array","items":{"type":"object","properties":{"doc":{"type":"object","properties":{"id":{"type":"string"},"last_updated_utc":{"type":"string","format":"date-time"},"created_utc":{"type":"string","format":"date-time"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"source":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"},"tag":{"type":"string"}},"required":["name","value"],"additionalProperties":false}},"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]}},"name":{"type":"string"},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"]},"aka":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false}},"associates":{"type":"array","items":{"type":"object","properties":{"association":{"type":"string"},"name":{"type":"string"}},"required":["association","name"],"additionalProperties":false}},"sources":{"type":"array","items":{"type":"string"}},"keywords":{"type":"array","items":{}},"media":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"snippet":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["snippet","title","url"],"additionalProperties":false}},"source_notes":{}},"required":["id","last_updated_utc","created_utc","types","name","entity_type","aka","sources","keywords"],"additionalProperties":false},"match_types":{"type":"array","items":{"type":"string"}},"match_types_details":{"type":"array","items":{"type":"object","properties":{"aml_types":{"type":"array","items":{"type":"string"}},"matching_name":{"type":"string"},"name_matches":{"type":"array","items":{"type":"object","properties":{"match_types":{"type":"array","items":{"type":"string"}},"query_term":{"type":"string"}},"required":["match_types","query_term"],"additionalProperties":false}},"secondary_matches":{"type":"array","items":{}},"sources":{"type":"array","items":{"type":"string"}}},"required":["aml_types","matching_name","name_matches","secondary_matches","sources"],"additionalProperties":false}},"match_status":{"type":"string"},"is_whitelisted":{"type":"boolean"},"score":{"type":"number"}},"required":["doc","match_types","match_types_details","match_status","is_whitelisted","score"],"additionalProperties":false}},"blacklist_hits":{"type":"array","items":{}}},"required":["client_ref","id","ref","searcher_id","assignee_id","match_status","risk_level","search_term","submitted_term","total_hits","total_matches","total_blacklist_hits","created_at","updated_at","labels","limit","offset"],"additionalProperties":false},"searchEntities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"last_updated_utc":{"type":"string","format":"date-time"},"created_utc":{"type":"string","format":"date-time"},"key_information":{"type":"object","properties":{"name":{"type":"string"},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"]},"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]},"nullable":true},"grouped_types":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]}},"required":["type"],"additionalProperties":false},"nullable":true},"match_types":{"type":"array","items":{"type":"string"},"nullable":true},"sources":{"type":"array","items":{"type":"string"},"nullable":true},"source_notes":{"nullable":true},"aka":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false},"nullable":true},"date_of_birth":{"type":"string","nullable":true},"dates_of_birth":{"type":"array","items":{"type":"string"},"nullable":true},"match_status":{"type":"string","enum":["unknown","no_match","potential_match","false_positive","true_positive","true_positive_approve","true_positive_reject"],"nullable":true},"risk_level":{"type":"string","enum":["low","medium","high","unknown"],"nullable":true},"is_whitelisted":{"type":"boolean","nullable":true},"age":{"type":"number","nullable":true},"death_age":{"nullable":true},"date_of_death":{"nullable":true},"primary_country":{"nullable":true},"country_names":{"type":"string","nullable":true},"designation":{"type":"string","nullable":true},"associates":{"type":"array","items":{"type":"object","properties":{"association":{"type":"string"},"name":{"type":"string"}},"required":["association","name"],"additionalProperties":false},"nullable":true}},"required":["name","entity_type"],"additionalProperties":false,"nullable":true},"uncategorized":{"type":"object","properties":{"keywords":{"type":"array","items":{},"nullable":true},"media":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"snippet":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["snippet","title","url"],"additionalProperties":false},"nullable":true},"assets":{"type":"array","items":{},"nullable":true},"match_types":{"type":"array","items":{"type":"string"},"nullable":true},"related":{"type":"array","items":{},"nullable":true},"fields":{"type":"array","items":{},"nullable":true}},"additionalProperties":false,"nullable":true},"full_listing":{"type":"object","additionalProperties":{"anyOf":[{"not":{}},{"type":"object","additionalProperties":{"anyOf":[{"not":{}},{"type":"object","properties":{"aml_types":{"type":"array","items":{"type":"string"},"nullable":true},"count":{"type":"number","nullable":true},"country_codes":{"type":"array","items":{"type":"string"},"nullable":true},"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"disclose_sources":{"type":"boolean","nullable":true},"listing_ended_utc":{"type":"string","nullable":true},"listing_started_utc":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"url":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true}]},"nullable":true}]},"nullable":true},"navigation":{"type":"object","properties":{"next":{"nullable":true},"previous":{"nullable":true}},"additionalProperties":false,"nullable":true}},"required":["id","last_updated_utc","created_utc"],"additionalProperties":false},"nullable":true},"requestData":{"type":"object","properties":{"search_term":{"type":"string","description":"represents name of the entity"},"client_ref":{"type":"string","description":"Your reference for this person/entity for which you are searching. Used for tracking searches and auto-whitelisting recurring results"},"search_profile":{"type":"string","nullable":true,"description":"The Profile ID of a search profile that can be retrieved from the UI"},"fuzziness":{"type":"number","minimum":0,"maximum":1,"nullable":true,"description":"determines how closely the returned results must match the supplied name. Overridden by exact_match"},"offset":{"type":"number","nullable":true,"description":"match results from the database, starting form the offset value"},"limit":{"type":"number","nullable":true,"description":"math results from the database, taking up this many matches each search"},"filters":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]},"nullable":true},"birth_year":{"type":"number","nullable":true},"remove_deceased":{"type":"number","minimum":0,"maximum":1,"nullable":true},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"],"nullable":true},"country_codes":{"type":"array","items":{"type":"string","enum":["AN","XK","AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"nullable":true}},"additionalProperties":false,"description":"specify filters within the search to narrow down the results"},"tags":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}},"nullable":true,"description":"name => value pairs, to search later using defined tags here"},"share_url":{"type":"number","minimum":0,"maximum":1,"nullable":true,"description":"include a shareable URL to access search publicly"},"exact_match":{"type":"boolean","nullable":true,"description":"Exact match disables all standard and optional matching behaviours (Honorifics, affixes, initials, glued name, name variation, equivalent names, extra words in entity,...) 0% fuzziness disables 1 letter typo matching but keeps all other matching behaviours (standard and optional)"}},"required":["search_term","client_ref"],"additionalProperties":false},"executionId":{"type":"string"},"alertId":{"type":"string","format":"uuid","nullable":true},"workflowSessionId":{"type":"string","nullable":true},"isMonitored":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","searchId","searchRef","searchResult","requestData","executionId","alertId","isMonitored","createdAt","updatedAt"],"additionalProperties":false},"nullable":true},"veriffWatchlistSearches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"workflowSessionId":{"type":"string","nullable":true},"sessionId":{"type":"string"},"attemptId":{"type":"string"},"checkType":{"type":"string","enum":["initial_result","updated_result"]},"matchStatus":{"type":"string","enum":["possible_match","no_match"]},"reviewStatus":{"type":"string","nullable":true},"searchTerm":{"type":"object","properties":{"name":{"type":"string","nullable":true},"year":{"type":"number","nullable":true},"lists":{"type":"array","items":{"type":"string"},"nullable":true},"countries":{"type":"array","items":{"type":"string"},"nullable":true},"exactMatch":{"type":"boolean","nullable":true},"matchThreshold":{"type":"number","nullable":true},"excludeDeceased":{"type":"boolean","nullable":true}},"additionalProperties":false,"nullable":true},"totalHits":{"type":"integer","minimum":-2147483648,"maximum":2147483647},"hits":{"type":"array","items":{"type":"object","properties":{"matchedName":{"type":"string","nullable":true},"countries":{"type":"array","items":{"type":"string"},"nullable":true},"dateOfBirth":{"type":"string","nullable":true},"dateOfDeath":{"type":"string","nullable":true},"matchTypes":{"type":"array","items":{},"nullable":true},"aka":{"type":"array","items":{},"nullable":true},"associates":{"type":"array","items":{},"nullable":true},"listingsRelatedToMatch":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"object","properties":{"sourceName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"snippet":{"type":"string","nullable":true},"date":{"type":"string","nullable":true}},"additionalProperties":true},"nullable":true},"sanctions":{"type":"array","items":{"type":"object","properties":{"sourceName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"snippet":{"type":"string","nullable":true},"date":{"type":"string","nullable":true}},"additionalProperties":true},"nullable":true},"fitnessProbity":{"type":"array","items":{"type":"object","properties":{"sourceName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"snippet":{"type":"string","nullable":true},"date":{"type":"string","nullable":true}},"additionalProperties":true},"nullable":true},"pep":{"type":"array","items":{"type":"object","properties":{"sourceName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"snippet":{"type":"string","nullable":true},"date":{"type":"string","nullable":true}},"additionalProperties":true},"nullable":true},"adverseMedia":{"type":"array","items":{"type":"object","properties":{"sourceName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"snippet":{"type":"string","nullable":true},"date":{"type":"string","nullable":true}},"additionalProperties":true},"nullable":true}},"additionalProperties":true,"nullable":true}},"additionalProperties":true}},"hasUnacknowledgedChanges":{"type":"boolean"},"monitorStatus":{"type":"string","enum":["enabled","disabled"],"nullable":true},"veriffCreatedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","sessionId","attemptId","checkType","matchStatus","searchTerm","totalHits","hits","hasUnacknowledgedChanges","veriffCreatedAt","createdAt","updatedAt"],"additionalProperties":false},"nullable":true},"tagsToEntity":{"type":"array","items":{"type":"object","properties":{"id":{},"tagId":{"type":"string"},"entityId":{"type":"string"},"entityType":{"type":"string","enum":["transactionReview","customer","alert","wallet"]},"createdBy":{"type":"string","nullable":true},"tags":{"type":"object","properties":{"id":{},"type":{"type":"string","enum":["transaction","individual","company","wallet"]},"title":{"type":"string"},"backgroundColor":{"type":"string"},"textColor":{"type":"string"},"workspaceId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"deletedAt":{"type":"string","format":"date-time","nullable":true},"createdBy":{"type":"string","nullable":true},"updatedBy":{"type":"string","nullable":true}},"required":["id","type","title","backgroundColor","textColor","workspaceId"],"additionalProperties":false}},"required":["id","tagId","entityId","entityType","tags"],"additionalProperties":false},"nullable":true},"customerId":{"type":"string","format":"uuid"}},"required":["cmsProjectId","workspaceId","organizationId","externalCustomerId","riskScore","type","onboardingLevel","status","createdAt","updatedAt","createdBy","updatedBy","customerWallets","customerClaims","customerDids","customerAddresses","customerIps","customerPhones","customerEmails","synapsSessions","customerId"],"additionalProperties":false},"example":{"cmsProjectId":"example","workspaceId":"example","organizationId":"example","externalCustomerId":"example","riskScore":"Low","type":"Individual","onboardingLevel":"Started","status":"Active","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","reason":"Manual review required","customerWallets":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","blockchainNamespace":"tezos","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","bigData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","onchainData":{"error":{"statusCode":400,"errorCode":"INVALID_ADDRESS","message":"The address provided isn't a valid address."}},"requestObject":{"crypto":"eth","address":"Alexanderplatz 1, 10178 Berlin, Germany","properties":[{"property":"score"},{"property":"entities"},{"property":"flags"},{"property":"currency"},{"property":"new_address"}],"label":"Example label","transactionsPerPage":42},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}],"merkleScienceData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","onchainData":{"statusCode":42,"identifier":"example","blockchain":42,"blockchain_verbose":"Bitcoin","customer_id":"3b241101-e2bb-4255-8caf-4136c566a962","type":42,"type_verbose":"DEFAULT","total_incoming_value":"example","total_incoming_value_usd":"example","total_outgoing_value":"example","total_outgoing_value_usd":"example","balance":42,"earliest_transaction_time":"example","latest_transaction_time":"example","risk_level":5,"risk_level_verbose":"No Risk Detected","created_at":"example","updated_at":"example","originator":[{"tag_type_verbose":"vip","tag_subtype_verbose":"vip","tag_name_verbose":"vip","total_value_usd":42,"exposure_type":"DEFAULT"}],"beneficiary":[{}],"tags":{"owner":{"tag_type_verbose":"vip","tag_subtype_verbose":"vip","tag_name_verbose":"vip"},"user":{"tag_type_verbose":"vip","tag_subtype_verbose":"vip","tag_name_verbose":"vip"}},"custom_tags":["vip"],"digital_assets":[{"name":"Jane Doe","symbol":"example"}]},"requestObject":{"identifier":"example","blockchain":"0","customer_id":"3b241101-e2bb-4255-8caf-4136c566a962","type":1,"show_alerts":true,"custom_tags":["vip"]},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}],"chainalysisData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","wallet":"example","onchainData":{"address":"Alexanderplatz 1, 10178 Berlin, Germany","risk":"Severe","riskReason":"Manual review required","cluster":{"name":"Jane Doe","category":"example"},"addressType":"PRIVATE_WALLET","addressIdentifications":[{"name":"Jane Doe","address":"Alexanderplatz 1, 10178 Berlin, Germany","category":"example","description":"Example description","url":"https://example.com/resource","createdAt":42}],"exposures":[{"category":"example","value":42,"exposureType":"direct","direction":"both_directions"}],"triggers":[{"category":"example","percentage":42,"message":"example","ruleTriggered":{"risk":"example","minThreshold":42,"maxThreshold":42,"exposureType":"direct","direction":"both_directions"}}],"status":"COMPLETE","poolMetadata":{"fees":42,"tokens":["tok_example_0001"]}},"requestObject":{"address":"Alexanderplatz 1, 10178 Berlin, Germany"},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}]}],"customerClaims":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","sub":"example","name":"Jane Doe","givenName":"Jane Doe","familyName":"Jane Doe","middleName":"Jane Doe","nickname":"Jane Doe","preferredUsername":"Jane Doe","profile":"example","picture":"example","pictureBase64":"example","website":"example","gender":"example","birthdate":"2024-05-14T09:30:00.000Z","zoneinfo":"example","locale":"example","countryOfResidence":"AFG","nationality":"AFG","updatedAt":"2024-05-14T09:30:00.000Z","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}],"customerDids":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","did":"example","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}],"customerAddresses":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","formatted":"Alexanderplatz 1, 10178 Berlin, Germany","street":"Alexanderplatz 1","city":"Berlin","state":"Berlin","region":"Berlin","postalCode":"10178","locality":"Mitte","country":"AFG","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}],"customerIps":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","ipAddress":"Alexanderplatz 1, 10178 Berlin, Germany","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","ipQualityScoreData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","scoreAnalysis":{"error":{"success":true,"message":"Invalid or unauthorized key. Please check the API key and try again.","request_id":"example"}},"requestObject":{"apiKey":"key_example_0001","ipValue":"example","userEmail":"jane.doe@example.com","userPhoneNumber":"+4915112345678"},"ipValue":"example","userEmail":"jane.doe@example.com","userPhoneNumber":"+4915112345678","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}]}],"customerPhones":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","phoneNumber":"+4915112345678","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","ipQualityScoreData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","scoreAnalysis":{"error":{"success":true,"message":"Invalid or unauthorized key. Please check the API key and try again.","request_id":"example"}},"requestObject":{"apiKey":"key_example_0001","ipValue":"example","userEmail":"jane.doe@example.com","userPhoneNumber":"+4915112345678"},"ipValue":"example","userEmail":"jane.doe@example.com","userPhoneNumber":"+4915112345678","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}]}],"customerEmails":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","email":"jane.doe@example.com","verified":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","ipQualityScoreData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","scoreAnalysis":{"error":{"success":true,"message":"Invalid or unauthorized key. Please check the API key and try again.","request_id":"example"}},"requestObject":{"apiKey":"key_example_0001","ipValue":"example","userEmail":"jane.doe@example.com","userPhoneNumber":"+4915112345678"},"ipValue":"example","userEmail":"jane.doe@example.com","userPhoneNumber":"+4915112345678","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}]}],"customerContactInformation":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","information":{"email":"jane.doe@example.com","phone":"+4915112345678","twitter":"example","discord":"example","telegram":"example"},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}],"customerDuplicates":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerIdLeft":"3b241101-e2bb-4255-8caf-4136c566a962","customerIdRight":"3b241101-e2bb-4255-8caf-4136c566a962","description":"Example description","customerInfoLeft":"example","customerInfoRight":"example","matchedFields":"example","exactMatch":true,"alertId":"3b241101-e2bb-4255-8caf-4136c566a962","workflowSessionId":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}],"synapsSessions":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","synapsSessionId":"example","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","sessionData":{"app":{"name":"Jane Doe","id":"example"},"session":{"alias":"example","id":"example","status":"APPROVED","sandbox":true}},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","synapsSteps":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","synapsStepId":"example","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","sessionId":"3b241101-e2bb-4255-8caf-4136c566a962","stepData":{"id":"example","type":"ID_DOCUMENT","metadata":{"ip":"203.0.113.42","user_agent":"example","platform":"example","browser_name":"Jane Doe","browser_version":"example","device":"example","customer_language":"example"},"status":"APPROVED","reason":{"code":"FORGED_REJECTION","message":{"original":"example","translated":"example"}},"document":{"country":"DE","type":"PASSPORT","fields":{"firstname":"Jane","lastname":"Doe","birth_date":"example","document_expiration":"example","document_number":"example","nationality":"DE"},"files":{"front":{"url":"https://example.com/resource","type":"DEFAULT","size":42,"base64":"example"},"back":{"url":"https://example.com/resource","type":"DEFAULT","size":42,"base64":"example"},"face":{"url":"https://example.com/resource","type":"DEFAULT","size":42,"base64":"example"}},"original_files":{"front":{"url":"https://example.com/resource","type":"DEFAULT","size":42,"base64":"example"},"back":{"url":"https://example.com/resource","type":"DEFAULT","size":42,"base64":"example"}}},"verification":{"liveness":{"file":{"url":"https://example.com/resource","type":"DEFAULT","size":42,"base64":"example"}}}},"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}]}],"audits":[{"timestamp":"2024-05-14T09:30:00.000Z","action":"create","author":"example","record":{"tagId":"example","entityId":"example","entityType":"transactionReview","tagTitle":"Example title"}}],"complyAdvantageSearches":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","searchId":42,"searchRef":"example","searchResult":{"client_ref":"example","id":42,"ref":"example","searcher_id":42,"assignee_id":42,"filters":{"types":["sanction"],"birth_year":2024,"remove_deceased":1,"entity_type":"person","country_codes":["AN"]},"match_status":"unknown","risk_level":"low","search_term":"example","submitted_term":"example","total_hits":42,"total_matches":42,"total_blacklist_hits":42,"created_at":"2024-05-14T09:30:00.000Z","updated_at":"2024-05-14T09:30:00.000Z","tags":[{"exampleKey":"vip"}],"labels":[{}],"limit":42,"offset":42,"searcher":{"id":42,"email":"jane.doe@example.com","name":"Jane Doe","phone":"+4915112345678","created_at":"2024-05-14T09:30:00.000Z","user_is_active":true},"assignee":{"id":42,"email":"jane.doe@example.com","name":"Jane Doe","phone":"+4915112345678","created_at":"2024-05-14T09:30:00.000Z","user_is_active":true},"hits":[{"doc":{"id":"example","last_updated_utc":"2024-05-14T09:30:00.000Z","created_utc":"2024-05-14T09:30:00.000Z","fields":[{"name":"Jane Doe","source":"example","value":"example","locale":"example","tag":"vip"}],"types":["sanction"],"name":"Jane Doe","entity_type":"person","aka":[{"name":"Jane Doe"}],"associates":[{"association":"example","name":"Jane Doe"}],"sources":["example"],"keywords":[{}],"media":[{"date":"2024-05-14T09:30:00.000Z","snippet":"example","title":"Example title","url":"https://example.com/resource"}],"source_notes":{}},"match_types":["DEFAULT"],"match_types_details":[{"aml_types":[],"matching_name":"Jane Doe","name_matches":[],"secondary_matches":[],"sources":[]}],"match_status":"ACTIVE","is_whitelisted":true,"score":42}],"blacklist_hits":[{}]},"searchEntities":[{"id":"example","last_updated_utc":"2024-05-14T09:30:00.000Z","created_utc":"2024-05-14T09:30:00.000Z","key_information":{"name":"Jane Doe","entity_type":"person","types":["sanction"],"grouped_types":[{"type":"sanction"}],"match_types":["DEFAULT"],"sources":["example"],"source_notes":{},"aka":[{"name":"Jane Doe"}],"date_of_birth":"example","dates_of_birth":["example"],"match_status":"unknown","risk_level":"low","is_whitelisted":true,"age":42,"death_age":{},"date_of_death":{},"primary_country":{},"country_names":"example","designation":"example","associates":[{"association":"example","name":"Jane Doe"}]},"uncategorized":{"keywords":[{}],"media":[{"date":"2024-05-14T09:30:00.000Z","snippet":"example","title":"Example title","url":"https://example.com/resource"}],"assets":[{}],"match_types":["DEFAULT"],"related":[{}],"fields":[{}]},"full_listing":{"exampleKey":{"exampleKey":{"aml_types":["DEFAULT"],"count":42,"country_codes":["example"],"data":[{"name":"Jane Doe","source":"example","value":"example"}],"disclose_sources":true,"listing_ended_utc":"example","listing_started_utc":"example","name":"Jane Doe","source":"example","url":"https://example.com/resource"}}},"navigation":{"next":{},"previous":{}}}],"requestData":{"search_term":"example","client_ref":"example","search_profile":"example","fuzziness":1,"offset":42,"limit":42,"filters":{"types":["sanction"],"birth_year":2024,"remove_deceased":1,"entity_type":"person","country_codes":["AN"]},"tags":[{"exampleKey":"vip"}],"share_url":1,"exact_match":true},"executionId":"example","alertId":"3b241101-e2bb-4255-8caf-4136c566a962","workflowSessionId":"example","isMonitored":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}],"veriffWatchlistSearches":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","workflowSessionId":"example","sessionId":"example","attemptId":"example","checkType":"initial_result","matchStatus":"possible_match","reviewStatus":"ACTIVE","searchTerm":{"name":"Jane Doe","year":2024,"lists":["example"],"countries":["example"],"exactMatch":true,"matchThreshold":42,"excludeDeceased":true},"totalHits":42,"hits":[{"matchedName":"Jane Doe","countries":["example"],"dateOfBirth":"example","dateOfDeath":"example","matchTypes":[{}],"aka":[{}],"associates":[{}],"listingsRelatedToMatch":{"warnings":[{"sourceName":"Jane Doe","sourceUrl":"https://example.com/resource","snippet":"example","date":"example"}],"sanctions":[{"sourceName":"Jane Doe","sourceUrl":"https://example.com/resource","snippet":"example","date":"example"}],"fitnessProbity":[{"sourceName":"Jane Doe","sourceUrl":"https://example.com/resource","snippet":"example","date":"example"}],"pep":[{"sourceName":"Jane Doe","sourceUrl":"https://example.com/resource","snippet":"example","date":"example"}],"adverseMedia":[{"sourceName":"Jane Doe","sourceUrl":"https://example.com/resource","snippet":"example","date":"example"}]}}],"hasUnacknowledgedChanges":true,"monitorStatus":"enabled","veriffCreatedAt":"2024-05-14T09:30:00.000Z","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}],"tagsToEntity":[{"id":"tte_3b241101e2bb42558caf4136","tagId":"example","entityId":"example","entityType":"transactionReview","createdBy":"workspace","tags":{"id":"tag_3b241101e2bb42558caf4136","type":"transaction","title":"Example title","backgroundColor":"example","textColor":"example","workspaceId":"example","organizationId":"example","deletedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}],"customerId":"3b241101-e2bb-4255-8caf-4136c566a962"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/batch":{"post":{"operationId":"individualsRouter-createIndividuals","summary":"Create multiple individuals","description":"Create multiple individuals for a given project.","tags":["Individuals"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customerData":{"type":"array","items":{"type":"object","properties":{"customerWallet":{"type":"object","properties":{"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]},"blockchainNamespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"],"nullable":true},"verified":{"type":"boolean","nullable":true},"createdBy":{"type":"string"}},"required":["wallet"],"additionalProperties":false},"customerClaims":{"type":"object","properties":{"sub":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"givenName":{"type":"string","nullable":true},"familyName":{"type":"string","nullable":true},"middleName":{"type":"string","nullable":true},"nickname":{"type":"string","nullable":true},"preferredUsername":{"type":"string","nullable":true},"profile":{"type":"string","nullable":true},"picture":{"type":"string","nullable":true},"pictureBase64":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"birthdate":{"type":"string","format":"date-time"},"zoneinfo":{"type":"string","nullable":true},"locale":{"type":"string","nullable":true},"countryOfResidence":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"nationality":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"createdBy":{"type":"string"}},"additionalProperties":false},"customerDid":{"type":"object","properties":{"did":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["did"],"additionalProperties":false},"externalId":{"type":"string"},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"]},"onboardingLevel":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded"]},"riskScore":{"type":"string","enum":["Low","Medium","High","No risk"]},"phoneNumber":{"type":"object","properties":{"phoneNumber":{"type":"string"},"verified":{"type":"boolean","nullable":true}},"required":["phoneNumber"],"additionalProperties":false},"email":{"type":"object","properties":{"email":{"type":"string","format":"email"},"verified":{"type":"boolean","nullable":true}},"required":["email"],"additionalProperties":false},"ipAddress":{"type":"string"}},"additionalProperties":false},"maxItems":100},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string"}},"required":["customerData","cmsProjectId","organizationId"],"additionalProperties":false},"example":{"customerData":[{"customerWallet":{"wallet":"example","blockchainNamespace":"tezos","verified":true,"createdBy":"workspace"},"customerClaims":{"sub":"example","name":"Jane Doe","givenName":"Jane Doe","familyName":"Jane Doe","middleName":"Jane Doe","nickname":"Jane Doe","preferredUsername":"Jane Doe","profile":"example","picture":"example","pictureBase64":"example","website":"example","gender":"example","birthdate":"2024-05-14T09:30:00.000Z","zoneinfo":"example","locale":"example","countryOfResidence":"AFG","nationality":"AFG","createdBy":"workspace"},"customerDid":{"did":"example","createdBy":"workspace","updatedBy":"workspace"},"externalId":"example","status":"Active","onboardingLevel":"Started","riskScore":"Low","phoneNumber":{"phoneNumber":"+4915112345678","verified":true},"email":{"email":"jane.doe@example.com","verified":true},"ipAddress":"203.0.113.42"}],"cmsProjectId":"example","organizationId":"example"}}}},"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"externalId":{"type":"string","nullable":true}},"required":["customerId"],"additionalProperties":false}},"example":[{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","externalId":"example"}]}}},"default":{"$ref":"#/components/responses/error"}}},"delete":{"operationId":"individualsRouter-deleteIndividuals","summary":"Delete multiple individuals","description":"Delete multiple individuals by id.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerIds","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}},"example":["3b241101-e2bb-4255-8caf-4136c566a962"]}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/merge":{"post":{"operationId":"individualsRouter-mergeIndividuals","summary":"Merge individuals","description":"Consolidate one or more source individual customers into a single target individual within the workspace resolved from the API key. This is a destructive, non-reversible operation: the source customers identified by `sourceCustomerIds` are merged into `targetCustomerId` and no longer exist as independent records afterwards. Use with care.","tags":["Individuals"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sourceCustomerIds":{"type":"array","items":{"type":"string"},"minItems":1},"targetCustomerId":{"type":"string"}},"required":["sourceCustomerIds","targetCustomerId"],"additionalProperties":false},"example":{"sourceCustomerIds":["example"],"targetCustomerId":"example"}}}},"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"},"example":"example"}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/documents":{"get":{"operationId":"individualsRouter-getIndividualDocuments","summary":"Get an individual documents data.","description":"Get individual's documents.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"objectKey":{"type":"string","format":"uuid"},"filename":{"type":"string"},"mimetype":{"type":"string"},"description":{"type":"string","nullable":true},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"presignedUrl":{"type":"string"}},"required":["id","objectKey","filename","mimetype","description","cmsProjectId","organizationId","workspaceId","createdAt","createdBy","presignedUrl"],"additionalProperties":false}},"example":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","objectKey":"3b241101-e2bb-4255-8caf-4136c566a962","filename":"Jane Doe","mimetype":"DEFAULT","description":"Example description","cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","presignedUrl":"https://example.com/resource"}]}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/video-document/{sessionId}":{"get":{"operationId":"individualsRouter-getIndividualVideoDocument","summary":"Get an individual video document.","description":"Get individual video document.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string"},"example":"example"},{"name":"sessionId","in":"path","required":true,"schema":{"type":"string"},"example":"example"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"objectKey":{"type":"string","format":"uuid"},"filename":{"type":"string"},"mimetype":{"type":"string"},"description":{"type":"string","nullable":true},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"presignedUrl":{"type":"string"}},"required":["id","objectKey","filename","mimetype","description","cmsProjectId","organizationId","workspaceId","createdAt","createdBy","presignedUrl"],"additionalProperties":false,"nullable":true}]},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","objectKey":"3b241101-e2bb-4255-8caf-4136c566a962","filename":"Jane Doe","mimetype":"DEFAULT","description":"Example description","cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","presignedUrl":"https://example.com/resource"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/scenario-executions":{"get":{"operationId":"individualsRouter-getIndividualScenarioExecutionHistory","summary":"Get individual scenario executions","description":"Get a single individual's scenario execution history using filters.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string"},"example":"example"},{"name":"currentPage","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"number"}],"default":0},"example":0},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"number"}],"default":50},"example":50},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-05-14T09:30:00.000Z"},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-05-14T09:30:00.000Z"},{"name":"scenarioTypes","in":"query","required":false,"schema":{"type":"string"},"example":"DEFAULT"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"workflow_session_id":{"type":"string","format":"uuid","nullable":true},"session_id":{"type":"string","nullable":true},"execution_id":{"type":"string"},"scenario_executions":{"type":"array","items":{"type":"object","properties":{"scenarioId":{"type":"string"},"rules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"execution_id":{"type":"string"},"cms_object_id":{"type":"string"},"cms_scenario_id":{"type":"string","nullable":true},"object_type":{"type":"string","enum":["PrivacyPreservingMonitoring","IndividualMonitoring","CompanyMonitoring","TransactionMonitoring","TFHE","OffChainZKP","ChallengeQuery","BlockchainPolicies","DatasetMonitoring"]},"result":{"anyOf":[{"type":"object","properties":{"result":{"type":"object","properties":{"is_valid":{"type":"boolean"},"reasons":{"type":"array","items":{"type":"string"}}},"required":["is_valid","reasons"],"additionalProperties":false}},"required":["result"],"additionalProperties":false},{}]},"rule_data":{"type":"object","properties":{"queryId":{"description":"Unique ID for the query"},"id":{"description":"Unique ID for the query"},"requestId":{"type":"number","nullable":true,"description":"Request ID for ZKPs"},"attribute":{"anyOf":[{"type":"string"},{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"],"additionalProperties":false}]},"secondaryAttribute":{"anyOf":[{"type":"string"},{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"],"additionalProperties":false}],"nullable":true},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"number"}}],"nullable":true},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"displayMode":{"type":"string","enum":["amount","percentage"],"nullable":true},"timeframe":{"type":"string","enum":["daily","weekly","monthly","yearly"],"nullable":true},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","enum":["ACTIVE_USERS_ADDRESSES"],"nullable":true},"type":{"type":"string","enum":["IDInformation","IDInformationTfhe","SelfieImage","IDImage","ProofOfResidence","AMLScreeningsResults","ID3","IDScan","IDScanSelfie","IDScanPassport"],"nullable":true}},"required":["attribute","operator"],"additionalProperties":false,"nullable":true},"status":{"type":"string","enum":["valid","not-valid","skipped","error","unknown"],"nullable":true},"executed_at":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time"},"documents":{"type":"array","items":{"type":"object","properties":{"documentType":{"type":"string","enum":["proof_of_residence","id_image_front","id_image_back","selfie_image"]},"url":{"type":"string","format":"uri"}},"required":["documentType","url"],"additionalProperties":false},"nullable":true}},"required":["id","execution_id","cms_object_id","object_type","executed_at","created_at"],"additionalProperties":false}},"scenarioStatus":{"type":"string","enum":["valid","not-valid","skipped","error","unknown"]},"executed_at":{"type":"string","format":"date-time"}},"required":["scenarioId","rules","scenarioStatus","executed_at"],"additionalProperties":false}},"execution_status":{"type":"string","enum":["valid","not-valid","skipped","error","unknown"]},"last_execution_date":{"type":"string","format":"date-time"}},"required":["execution_id","scenario_executions","execution_status","last_execution_date"],"additionalProperties":false}},"example":[{"workflow_session_id":"3b241101-e2bb-4255-8caf-4136c566a962","session_id":"example","execution_id":"example","scenario_executions":[{"scenarioId":"example","rules":[{"id":"example","execution_id":"example","cms_object_id":"example","cms_scenario_id":"example","object_type":"PrivacyPreservingMonitoring","result":{"result":{"is_valid":true,"reasons":[]}},"rule_data":{"queryId":"query_3b241101e2bb42558caf4136","id":"query_3b241101e2bb42558caf4136","requestId":42,"attribute":"example","secondaryAttribute":"example","value":true,"operator":"$noop","displayMode":"amount","timeframe":"daily","datasetColumnId":"datasetc_3b241101e2bb42558caf4136","sourceDatasetColumnId":"datasetc_3b241101e2bb42558caf4136","specialDataSetType":"ACTIVE_USERS_ADDRESSES","type":"IDInformation"},"status":"valid","executed_at":"2024-05-14T09:30:00.000Z","created_at":"2024-05-14T09:30:00.000Z","documents":[]}],"scenarioStatus":"valid","executed_at":"2024-05-14T09:30:00.000Z"}],"execution_status":"valid","last_execution_date":"2024-05-14T09:30:00.000Z"}]}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/scenario-executions/{executionId}":{"get":{"operationId":"individualsRouter-getIndividualScenarioExecution","summary":"Get an individual scenario execution data for one scenario execution.","description":"Get a single individual's scenario execution data.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"executionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"execution_id":{"type":"string"},"session_id":{"type":"string"},"workflow_session_id":{"type":"string","format":"uuid","nullable":true},"scenario_executions":{"type":"array","items":{"type":"object","properties":{"scenarioId":{"type":"string"},"rules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"execution_id":{"type":"string"},"cms_object_id":{"type":"string"},"cms_scenario_id":{"type":"string","nullable":true},"object_type":{"type":"string","enum":["PrivacyPreservingMonitoring","IndividualMonitoring","CompanyMonitoring","TransactionMonitoring","TFHE","OffChainZKP","ChallengeQuery","BlockchainPolicies","DatasetMonitoring"]},"result":{"anyOf":[{"type":"object","properties":{"result":{"type":"object","properties":{"is_valid":{"type":"boolean"},"reasons":{"type":"array","items":{"type":"string"}}},"required":["is_valid","reasons"],"additionalProperties":false}},"required":["result"],"additionalProperties":false},{}]},"data":{"anyOf":[{},{"type":"object","properties":{"ID3":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"AMLScreeningsResults":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDScan":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDInformation":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDScanSelfie":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"SelfieImage":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDScanPassport":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDImage":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"ProofOfResidence":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"RulesEngineInputData":{"type":"object","additionalProperties":{},"nullable":true}},"additionalProperties":false}]},"rule_data":{"type":"object","properties":{"queryId":{"description":"Unique ID for the query"},"id":{"description":"Unique ID for the query"},"requestId":{"type":"number","nullable":true,"description":"Request ID for ZKPs"},"attribute":{"anyOf":[{"type":"string"},{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"],"additionalProperties":false}]},"secondaryAttribute":{"anyOf":[{"type":"string"},{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"],"additionalProperties":false}],"nullable":true},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"number"}}],"nullable":true},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"displayMode":{"type":"string","enum":["amount","percentage"],"nullable":true},"timeframe":{"type":"string","enum":["daily","weekly","monthly","yearly"],"nullable":true},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","enum":["ACTIVE_USERS_ADDRESSES"],"nullable":true},"type":{"type":"string","enum":["IDInformation","IDInformationTfhe","SelfieImage","IDImage","ProofOfResidence","AMLScreeningsResults","ID3","IDScan","IDScanSelfie","IDScanPassport"],"nullable":true}},"required":["attribute","operator"],"additionalProperties":false,"nullable":true},"status":{"type":"string","enum":["valid","not-valid","skipped","error","unknown"],"nullable":true},"executed_at":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time"},"documents":{"type":"array","items":{"type":"object","properties":{"documentType":{"type":"string","enum":["proof_of_residence","id_image_front","id_image_back","selfie_image"]},"url":{"type":"string","format":"uri"}},"required":["documentType","url"],"additionalProperties":false},"nullable":true}},"required":["id","execution_id","cms_object_id","object_type","executed_at","created_at"],"additionalProperties":false}},"scenarioStatus":{"type":"string","enum":["valid","not-valid","skipped","error","unknown"]},"executed_at":{"type":"string","format":"date-time"}},"required":["scenarioId","rules","scenarioStatus","executed_at"],"additionalProperties":false}},"execution_status":{"type":"string","enum":["valid","not-valid","skipped","error","unknown"]},"last_execution_date":{"type":"string","format":"date-time"}},"required":["execution_id","session_id","scenario_executions","execution_status","last_execution_date"],"additionalProperties":false},"example":{"execution_id":"example","session_id":"example","workflow_session_id":"3b241101-e2bb-4255-8caf-4136c566a962","scenario_executions":[{"scenarioId":"example","rules":[{"id":"example","execution_id":"example","cms_object_id":"example","cms_scenario_id":"example","object_type":"PrivacyPreservingMonitoring","result":{"result":{"is_valid":true,"reasons":["Manual review required"]}},"data":{},"rule_data":{"queryId":"query_3b241101e2bb42558caf4136","id":"query_3b241101e2bb42558caf4136","requestId":42,"attribute":"example","secondaryAttribute":"example","value":true,"operator":"$noop","displayMode":"amount","timeframe":"daily","datasetColumnId":"datasetc_3b241101e2bb42558caf4136","sourceDatasetColumnId":"datasetc_3b241101e2bb42558caf4136","specialDataSetType":"ACTIVE_USERS_ADDRESSES","type":"IDInformation"},"status":"valid","executed_at":"2024-05-14T09:30:00.000Z","created_at":"2024-05-14T09:30:00.000Z","documents":[{"documentType":"proof_of_residence","url":"https://example.com/resource"}]}],"scenarioStatus":"valid","executed_at":"2024-05-14T09:30:00.000Z"}],"execution_status":"valid","last_execution_date":"2024-05-14T09:30:00.000Z"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/individuals/{customerId}/duplicates":{"get":{"operationId":"individualsRouter-getDuplicatesForIndividual","summary":"Get individual's duplicates by customerId","description":"Get individual's duplicates with customerId.","tags":["Individuals"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerIdLeft":{"type":"string","format":"uuid"},"customerIdRight":{"type":"string","format":"uuid"},"description":{"type":"string","nullable":true},"customerInfoLeft":{"type":"string","nullable":true},"customerInfoRight":{"type":"string","nullable":true},"matchedFields":{"type":"string","nullable":true},"exactMatch":{"type":"boolean","nullable":true},"alertId":{"type":"string","format":"uuid","nullable":true},"workflowSessionId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerIdLeft","customerIdRight","description","customerInfoLeft","customerInfoRight","matchedFields","exactMatch","alertId","workflowSessionId","createdAt","updatedAt"],"additionalProperties":false}},"example":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerIdLeft":"3b241101-e2bb-4255-8caf-4136c566a962","customerIdRight":"3b241101-e2bb-4255-8caf-4136c566a962","description":"Example description","customerInfoLeft":"example","customerInfoRight":"example","matchedFields":"example","exactMatch":true,"alertId":"3b241101-e2bb-4255-8caf-4136c566a962","workflowSessionId":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}]}}},"default":{"$ref":"#/components/responses/error"}}}},"/workflows/{workflowId}/signatures/evm":{"post":{"operationId":"signatureGating-getTxAuthDataSignature","summary":"Get signature for a tx data","description":"Evaluate the workflow's sig-gating rules for the given EVM transaction and return the gating decision. Both outcomes are returned with HTTP 200: when authorized, the response is `{ isAuthorized: true, signature, payload, blockExpiration }` (the signature the caller submits on-chain); when denied, it is `{ isAuthorized: false, errorMessage }` and NO signature is issued. Callers MUST branch on `isAuthorized` and must not treat a 200 as authorization on its own.","tags":["SigGating"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chainId":{"type":"string","enum":["1","137","80002","43114","43113","42161","421614","11155111","8453","84532","56","97","1284","1285","10","11155420","1291","295","296","254","2024","20241133","9990","3338","2040","78600","72080","50","51"],"description":"a numeric value that identifies the chain of the address. There are many sites that retrieve information on chainIDs such as <a href='https://chainlist.org/'>https://chainlist.org</a>."},"contractAbi":{"type":"array","items":{"type":"object","additionalProperties":{}}},"contractAddress":{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},"functionName":{"type":"string"},"args":{"type":"array","items":{}},"userAddress":{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},"blockExpiration":{"type":"integer"},"nonce":{"type":"integer"}},"required":["chainId","contractAbi","contractAddress","functionName","args","userAddress"],"additionalProperties":false},"example":{"chainId":"1","contractAbi":[{"exampleKey":{}}],"contractAddress":"0x3b241101e2bb42558caf4136","functionName":"Jane Doe","args":[{}],"userAddress":"0x3b241101e2bb42558caf4136","blockExpiration":42,"nonce":42}}}},"parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"isAuthorized":{"type":"boolean","enum":[true]},"signature":{"type":"string","description":"0x string"},"payload":{"type":"string"},"blockExpiration":{"type":"number"}},"required":["isAuthorized","signature","payload","blockExpiration"],"additionalProperties":false},{"type":"object","properties":{"isAuthorized":{"type":"boolean","enum":[false]},"errorMessage":{"type":"string"}},"required":["isAuthorized","errorMessage"],"additionalProperties":false}]},"example":{"isAuthorized":true,"signature":"0x3b241101e2bb42558caf4136","payload":"example","blockExpiration":42}}}},"default":{"$ref":"#/components/responses/error"}}}},"/workflows/{workflowId}/signatures/tezos":{"post":{"operationId":"signatureGating-getTezosTxAuthDataSignature","summary":"Get signature for a tezos tx data","description":"Evaluate the workflow's sig-gating rules for the given Tezos transaction and return the gating decision. Both outcomes are returned with HTTP 200: authorized → `{ isAuthorized: true, signature, blockExpiration }` (the signature to submit on-chain); denied → `{ isAuthorized: false, errorMessage }` with no signature. Callers MUST branch on `isAuthorized` and must not treat a 200 as authorization on its own.","tags":["SigGating"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chainID":{"type":"string","enum":["NetXdQprcVkpaWU","NetXnHfVqm9iesp"],"description":"a numeric value that identifies the chain of the address. There are many sites that retrieve information on chainIDs such as <a href='https://chainlist.org/'>https://chainlist.org</a>."},"contractAddress":{"type":"string","description":"Tezos contract address"},"functionName":{"type":"string","description":"Tezos entrypoint name"},"args":{"type":"string"},"userAddress":{"type":"string","description":"Tezos address (implicit account)"},"blockExpiration":{"type":"integer"},"nonce":{"type":"integer"}},"required":["chainID","contractAddress","functionName","args","userAddress"],"additionalProperties":false},"example":{"chainID":"NetXdQprcVkpaWU","contractAddress":"KT13b241101e2bb42558caf4136","functionName":"%3b241101e2bb42558caf4136","args":"example","userAddress":"tz3b241101e2bb42558caf4136","blockExpiration":42,"nonce":42}}}},"parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"isAuthorized":{"type":"boolean","enum":[true]},"signature":{"type":"string"},"blockExpiration":{"type":"number"}},"required":["isAuthorized","signature","blockExpiration"],"additionalProperties":false},{"type":"object","properties":{"isAuthorized":{"type":"boolean","enum":[false]},"errorMessage":{}},"required":["isAuthorized"],"additionalProperties":false}]},"example":{"isAuthorized":true,"signature":"edsig3b241101e2bb42558caf4136","blockExpiration":42}}}},"default":{"$ref":"#/components/responses/error"}}}},"/alerts":{"post":{"operationId":"alertsRouter-createAlert","summary":"Create alert","description":"Create a new alert (a compliance/monitoring flag) in the caller's authorized scope. Requires a valid API key. Returns the created alert record.","tags":["Alerts"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"severity":{"type":"string","enum":["Low","Medium","High"]},"category":{"type":"string","enum":["Onboarding","Ongoing monitoring"]},"type":{"type":"string","enum":["AML Screening","IP Screening","Email Screening","KYC Drop-off","Onchain Monitoring","Fraud","Transaction Monitoring","Duplicate","Individual Monitoring","Compliance Review Required"]},"status":{"type":"string","enum":["Open","Under Investigation","Pending","Closed","Escalated"]},"name":{"type":"string"},"description":{"type":"string","nullable":true},"assignedTo":{"type":"string","nullable":true},"seen":{"type":"boolean"},"customerId":{"type":"string","format":"uuid"},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"workflowSessionId":{"type":"string","nullable":true},"scenarioId":{},"transactionIds":{"type":"array","items":{}}},"required":["severity","category","type","status","name","customerId","cmsProjectId"],"additionalProperties":false},"example":{"severity":"Low","category":"Onboarding","type":"AML Screening","status":"Open","name":"Jane Doe","description":"Example description","assignedTo":"example","seen":true,"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","cmsProjectId":"example","organizationId":"example","workspaceId":"example","reason":"Manual review required","workflowSessionId":"example","scenarioId":"scenario_3b241101e2bb42558caf4136","transactionIds":["tx_3b241101e2bb42558caf4136"]}}}},"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}}},"default":{"$ref":"#/components/responses/error"}}}},"/alerts/{id}":{"get":{"operationId":"alertsRouter-getAlert","summary":"Get alert","description":"Fetch a single alert and its associated detail by its alert id, within the caller's authorized scope. Read-only.","tags":["Alerts"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"severity":{"type":"string","enum":["Low","Medium","High"]},"category":{"type":"string","enum":["Onboarding","Ongoing monitoring"]},"type":{"type":"string","enum":["AML Screening","IP Screening","Email Screening","KYC Drop-off","Onchain Monitoring","Fraud","Transaction Monitoring","Duplicate","Individual Monitoring","Compliance Review Required"]},"status":{"type":"string","enum":["Open","Under Investigation","Pending","Closed","Escalated"]},"name":{"type":"string"},"description":{"type":"string","nullable":true},"assignedTo":{"type":"string","nullable":true},"seen":{"type":"boolean"},"customerId":{"type":"string","format":"uuid"},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"reason":{"type":"string","nullable":true},"workflowSessionId":{"type":"string","nullable":true},"notes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"data":{},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"objectKey":{"type":"string","format":"uuid"},"filename":{"type":"string"},"mimetype":{"type":"string"},"description":{"type":"string","nullable":true},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"presignedUrl":{"type":"string"}},"required":["id","objectKey","filename","mimetype","description","cmsProjectId","organizationId","workspaceId","createdAt","createdBy","presignedUrl"],"additionalProperties":false}}},"required":["id","name","description","cmsProjectId","organizationId","workspaceId","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"audits":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"action":{"type":"string","enum":["create","update","delete","attach","detach","duplicate"]},"author":{"type":"string","nullable":true},"record":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"severity":{"type":"string","enum":["Low","Medium","High"]},"category":{"type":"string","enum":["Onboarding","Ongoing monitoring"]},"type":{"type":"string","enum":["AML Screening","IP Screening","Email Screening","KYC Drop-off","Onchain Monitoring","Fraud","Transaction Monitoring","Duplicate","Individual Monitoring","Compliance Review Required"]},"status":{"type":"string","enum":["Open","Under Investigation","Pending","Closed","Escalated"]},"name":{"type":"string"},"description":{"type":"string","nullable":true},"assignedTo":{"type":"string","nullable":true},"seen":{"type":"boolean"},"customerId":{"type":"string","format":"uuid"},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"reason":{"type":"string","nullable":true},"workflowSessionId":{"type":"string","nullable":true},"notes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"data":{},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"objectKey":{"type":"string","format":"uuid"},"filename":{"type":"string"},"mimetype":{"type":"string"},"description":{"type":"string","nullable":true},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"presignedUrl":{"type":"string"}},"required":["id","objectKey","filename","mimetype","description","cmsProjectId","organizationId","workspaceId","createdAt","createdBy","presignedUrl"],"additionalProperties":false}}},"required":["id","name","description","cmsProjectId","organizationId","workspaceId","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}}},"additionalProperties":false}},"required":["timestamp","action","record"],"additionalProperties":false}},"complyAdvantageData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid","nullable":true},"searchId":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"nullable":true},"searchRef":{"type":"string","nullable":true},"searchResult":{"type":"object","properties":{"client_ref":{"type":"string"},"id":{"type":"number"},"ref":{"type":"string"},"searcher_id":{"type":"number"},"assignee_id":{"type":"number"},"filters":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]},"nullable":true},"birth_year":{"type":"number","nullable":true},"remove_deceased":{"type":"number","minimum":0,"maximum":1,"nullable":true},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"],"nullable":true},"country_codes":{"type":"array","items":{"type":"string","enum":["AN","XK","AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"nullable":true}},"additionalProperties":false},"match_status":{"type":"string","enum":["unknown","no_match","potential_match","false_positive","true_positive","true_positive_approve","true_positive_reject"]},"risk_level":{"type":"string","enum":["low","medium","high","unknown"]},"search_term":{"type":"string"},"submitted_term":{"type":"string"},"total_hits":{"type":"number"},"total_matches":{"type":"number"},"total_blacklist_hits":{"type":"number"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"tags":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"labels":{"type":"array","items":{}},"limit":{"type":"number"},"offset":{"type":"number"},"searcher":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string","format":"email"},"name":{"type":"string"},"phone":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"user_is_active":{"type":"boolean"}},"required":["id","email","name","phone","created_at","user_is_active"],"additionalProperties":false},"assignee":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string","format":"email"},"name":{"type":"string"},"phone":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"user_is_active":{"type":"boolean"}},"required":["id","email","name","phone","created_at","user_is_active"],"additionalProperties":false},"hits":{"type":"array","items":{"type":"object","properties":{"doc":{"type":"object","properties":{"id":{"type":"string"},"last_updated_utc":{"type":"string","format":"date-time"},"created_utc":{"type":"string","format":"date-time"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"source":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"},"tag":{"type":"string"}},"required":["name","value"],"additionalProperties":false}},"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]}},"name":{"type":"string"},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"]},"aka":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false}},"associates":{"type":"array","items":{"type":"object","properties":{"association":{"type":"string"},"name":{"type":"string"}},"required":["association","name"],"additionalProperties":false}},"sources":{"type":"array","items":{"type":"string"}},"keywords":{"type":"array","items":{}},"media":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"snippet":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["snippet","title","url"],"additionalProperties":false}},"source_notes":{}},"required":["id","last_updated_utc","created_utc","types","name","entity_type","aka","sources","keywords"],"additionalProperties":false},"match_types":{"type":"array","items":{"type":"string"}},"match_types_details":{"type":"array","items":{"type":"object","properties":{"aml_types":{"type":"array","items":{"type":"string"}},"matching_name":{"type":"string"},"name_matches":{"type":"array","items":{"type":"object","properties":{"match_types":{"type":"array","items":{"type":"string"}},"query_term":{"type":"string"}},"required":["match_types","query_term"],"additionalProperties":false}},"secondary_matches":{"type":"array","items":{}},"sources":{"type":"array","items":{"type":"string"}}},"required":["aml_types","matching_name","name_matches","secondary_matches","sources"],"additionalProperties":false}},"match_status":{"type":"string"},"is_whitelisted":{"type":"boolean"},"score":{"type":"number"}},"required":["doc","match_types","match_types_details","match_status","is_whitelisted","score"],"additionalProperties":false}},"blacklist_hits":{"type":"array","items":{}}},"required":["client_ref","id","ref","searcher_id","assignee_id","match_status","risk_level","search_term","submitted_term","total_hits","total_matches","total_blacklist_hits","created_at","updated_at","labels","limit","offset"],"additionalProperties":false},"searchEntities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"last_updated_utc":{"type":"string","format":"date-time"},"created_utc":{"type":"string","format":"date-time"},"key_information":{"type":"object","properties":{"name":{"type":"string"},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"]},"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]},"nullable":true},"grouped_types":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]}},"required":["type"],"additionalProperties":false},"nullable":true},"match_types":{"type":"array","items":{"type":"string"},"nullable":true},"sources":{"type":"array","items":{"type":"string"},"nullable":true},"source_notes":{"nullable":true},"aka":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false},"nullable":true},"date_of_birth":{"type":"string","nullable":true},"dates_of_birth":{"type":"array","items":{"type":"string"},"nullable":true},"match_status":{"type":"string","enum":["unknown","no_match","potential_match","false_positive","true_positive","true_positive_approve","true_positive_reject"],"nullable":true},"risk_level":{"type":"string","enum":["low","medium","high","unknown"],"nullable":true},"is_whitelisted":{"type":"boolean","nullable":true},"age":{"type":"number","nullable":true},"death_age":{"nullable":true},"date_of_death":{"nullable":true},"primary_country":{"nullable":true},"country_names":{"type":"string","nullable":true},"designation":{"type":"string","nullable":true},"associates":{"type":"array","items":{"type":"object","properties":{"association":{"type":"string"},"name":{"type":"string"}},"required":["association","name"],"additionalProperties":false},"nullable":true}},"required":["name","entity_type"],"additionalProperties":false,"nullable":true},"uncategorized":{"type":"object","properties":{"keywords":{"type":"array","items":{},"nullable":true},"media":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"snippet":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["snippet","title","url"],"additionalProperties":false},"nullable":true},"assets":{"type":"array","items":{},"nullable":true},"match_types":{"type":"array","items":{"type":"string"},"nullable":true},"related":{"type":"array","items":{},"nullable":true},"fields":{"type":"array","items":{},"nullable":true}},"additionalProperties":false,"nullable":true},"full_listing":{"type":"object","additionalProperties":{"anyOf":[{"not":{}},{"type":"object","additionalProperties":{"anyOf":[{"not":{}},{"type":"object","properties":{"aml_types":{"type":"array","items":{"type":"string"},"nullable":true},"count":{"type":"number","nullable":true},"country_codes":{"type":"array","items":{"type":"string"},"nullable":true},"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"disclose_sources":{"type":"boolean","nullable":true},"listing_ended_utc":{"type":"string","nullable":true},"listing_started_utc":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"url":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true}]},"nullable":true}]},"nullable":true},"navigation":{"type":"object","properties":{"next":{"nullable":true},"previous":{"nullable":true}},"additionalProperties":false,"nullable":true}},"required":["id","last_updated_utc","created_utc"],"additionalProperties":false},"nullable":true},"requestData":{"type":"object","properties":{"search_term":{"type":"string","description":"represents name of the entity"},"client_ref":{"type":"string","description":"Your reference for this person/entity for which you are searching. Used for tracking searches and auto-whitelisting recurring results"},"search_profile":{"type":"string","nullable":true,"description":"The Profile ID of a search profile that can be retrieved from the UI"},"fuzziness":{"type":"number","minimum":0,"maximum":1,"nullable":true,"description":"determines how closely the returned results must match the supplied name. Overridden by exact_match"},"offset":{"type":"number","nullable":true,"description":"match results from the database, starting form the offset value"},"limit":{"type":"number","nullable":true,"description":"math results from the database, taking up this many matches each search"},"filters":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]},"nullable":true},"birth_year":{"type":"number","nullable":true},"remove_deceased":{"type":"number","minimum":0,"maximum":1,"nullable":true},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"],"nullable":true},"country_codes":{"type":"array","items":{"type":"string","enum":["AN","XK","AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"nullable":true}},"additionalProperties":false,"description":"specify filters within the search to narrow down the results"},"tags":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}},"nullable":true,"description":"name => value pairs, to search later using defined tags here"},"share_url":{"type":"number","minimum":0,"maximum":1,"nullable":true,"description":"include a shareable URL to access search publicly"},"exact_match":{"type":"boolean","nullable":true,"description":"Exact match disables all standard and optional matching behaviours (Honorifics, affixes, initials, glued name, name variation, equivalent names, extra words in entity,...) 0% fuzziness disables 1 letter typo matching but keeps all other matching behaviours (standard and optional)"}},"required":["search_term","client_ref"],"additionalProperties":false},"executionId":{"type":"string"},"alertId":{"type":"string","format":"uuid","nullable":true},"workflowSessionId":{"type":"string","nullable":true},"isMonitored":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","searchId","searchRef","searchResult","requestData","executionId","alertId","isMonitored","createdAt","updatedAt"],"additionalProperties":false},"nullable":true},"duplicateData":{"type":"array","items":{"type":"object","properties":{"original":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"customerInfo":{"type":"string","nullable":true},"profilePictureUrl":{"type":"string","nullable":true},"idDocumentUrl":{"type":"string","nullable":true}},"required":["customerId"],"additionalProperties":false},"duplicate":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"customerInfo":{"type":"string","nullable":true},"profilePictureUrl":{"type":"string","nullable":true},"idDocumentUrl":{"type":"string","nullable":true}},"required":["customerId"],"additionalProperties":false}},"required":["original","duplicate"],"additionalProperties":false},"nullable":true},"cmsScenarioId":{"type":"string","nullable":true},"scenarioName":{"type":"string","nullable":true},"results":{"type":"array","items":{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"AMLScreeningsResults":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"ProofOfResidence":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDScanSelfie":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDImage":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDInformation":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"SelfieImage":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"RulesEngineInputData":{"type":"object","additionalProperties":{},"nullable":true},"TFHEResult":{"type":"string","nullable":true}},"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"typ":{"type":"string","enum":["application/iden3-zkp-json","application/iden3comm-plain-json","application/iden3comm-signed-json"]},"type":{"type":"string","enum":["https://iden3-communication.io/authorization/1.0/request","https://iden3-communication.io/authorization/1.0/response","https://iden3-communication.io/credentials/1.0/issuance-request","https://iden3-communication.io/credentials/1.0/fetch-request","https://iden3-communication.io/credentials/1.0/offer","https://iden3-communication.io/credentials/1.0/issuance-response","https://iden3-communication.io/credentials/1.0/refresh","https://iden3-communication.io/devices/1.0/registration","https://iden3-communication.io/messages/1.0/fetch","https://iden3-communication.io/proofs/1.0/request","https://iden3-communication.io/proofs/1.0/response","https://iden3-communication.io/revocation/1.0/request-status","https://iden3-communication.io/revocation/1.0/status","https://iden3-communication.io/proofs/1.0/contract-invoke-request","https://iden3-communication.io/proofs/1.0/contract-invoke-response","https://iden3-communication.io/credentials/1.0/onchain-offer","https://iden3-communication.io/credentials/0.1/proposal-request","https://iden3-communication.io/credentials/0.1/proposal","https://iden3-communication.io/credentials/0.1/payment-request","https://iden3-communication.io/credentials/0.1/payment"]},"thid":{"type":"string"},"body":{"type":"object","properties":{"callbackUrl":{"type":"string"},"reason":{"type":"string"},"did_doc":{},"message":{"type":"string"},"scope":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"number"},{"type":"string"}]},"circuitId":{"type":"string"},"optional":{"type":"boolean"},"query":{"type":"object","additionalProperties":{}}},"required":["id","circuitId","query"],"additionalProperties":false}}},"required":["callbackUrl","scope"],"additionalProperties":false},"from":{"type":"string"},"to":{"type":"string"}},"required":["id","type","body","from"],"additionalProperties":false}],"nullable":true},"ruleData":{"type":"object","properties":{"queryId":{"description":"Unique ID for the query"},"id":{"description":"Unique ID for the query"},"requestId":{"type":"number","nullable":true,"description":"Request ID for ZKPs"},"attribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"],"additionalProperties":false},"secondaryAttribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"],"additionalProperties":false,"nullable":true},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"number"}}],"nullable":true},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"displayMode":{"type":"string","enum":["amount","percentage"],"nullable":true},"timeframe":{"type":"string","enum":["daily","weekly","monthly","yearly"],"nullable":true},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","enum":["ACTIVE_USERS_ADDRESSES"],"nullable":true}},"required":["attribute","operator"],"additionalProperties":false,"nullable":true},"status":{"type":"string","enum":["valid","not-valid","skipped","error","unknown"],"nullable":true},"cmsScenarioId":{"type":"string","nullable":true},"scenarioName":{"type":"string","nullable":true},"queryBlocksMergeOperator":{"type":"string","enum":["AND","OR"],"nullable":true},"queryGroupId":{"type":"string","nullable":true},"queryGroupOperator":{"type":"string","enum":["AND","OR"],"nullable":true},"queryGroupIndex":{"type":"number","nullable":true}},"additionalProperties":false},"nullable":true},"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"nullable":true},"transactionDate":{"type":"string","format":"date-time","nullable":true},"transactionType":{"type":"string","enum":["crypto","fiat"],"nullable":true},"customerId":{"type":"string","format":"uuid","nullable":true},"transactionInfo":{"type":"object","properties":{"hash":{"type":"string","nullable":true},"blockchainChainId":{"type":"string","nullable":true},"direction":{"type":"string","enum":["IN","OUT","EXCHANGE"],"nullable":true},"amount":{"type":"string","nullable":true},"currencyCode":{"type":"string","nullable":true},"hashUrl":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"transactionAmounts":{"type":"array","items":{"type":"object","properties":{"fieldName":{"type":"string","enum":["amount","targetAmount","networkFeeAmount","platformFeeAmount","transactionFeeAmount"],"nullable":true},"currencyCode":{"type":"string","nullable":true},"amount":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"transactionReview":{"type":"object","properties":{"riskLevel":{"type":"string","enum":["Low","Medium","High","No risk"],"nullable":true},"status":{"type":"string","enum":["pending","approved","under_investigation","blocked","failed"],"nullable":true}},"additionalProperties":false,"nullable":true},"originator":{"type":"object","properties":{"partyId":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["individual","company","smart-contract"],"nullable":true},"transactionMethod":{"type":"object","properties":{"type":{"type":"string","enum":["card","account","crypto"],"nullable":true},"accountId":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"institution":{"type":"object","properties":{"name":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"address":{"type":"object","properties":{"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true}},"additionalProperties":false,"nullable":true}},"additionalProperties":false,"nullable":true},"beneficiary":{"type":"object","properties":{"partyId":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["individual","company","smart-contract"],"nullable":true},"transactionMethod":{"type":"object","properties":{"type":{"type":"string","enum":["card","account","crypto"],"nullable":true},"accountId":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"institution":{"type":"object","properties":{"name":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"address":{"type":"object","properties":{"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true}},"additionalProperties":false,"nullable":true}},"additionalProperties":false,"nullable":true}},"additionalProperties":false},"nullable":true},"tagsToEntity":{"type":"array","items":{"type":"object","properties":{"id":{},"tagId":{"type":"string"},"entityId":{"type":"string"},"entityType":{"type":"string","enum":["transactionReview","customer","alert","wallet"]},"createdBy":{"type":"string","nullable":true},"tags":{"type":"object","properties":{"id":{},"type":{"type":"string","enum":["transaction","individual","company","wallet"]},"title":{"type":"string"},"backgroundColor":{"type":"string"},"textColor":{"type":"string"},"workspaceId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"deletedAt":{"type":"string","format":"date-time","nullable":true},"createdBy":{"type":"string","nullable":true},"updatedBy":{"type":"string","nullable":true}},"required":["id","type","title","backgroundColor","textColor","workspaceId"],"additionalProperties":false}},"required":["id","tagId","entityId","entityType","tags"],"additionalProperties":false},"nullable":true},"rulesMergeOperator":{"type":"string","enum":["AND","OR"],"nullable":true}},"required":["id","severity","category","type","status","name","description","assignedTo","seen","customerId","cmsProjectId","organizationId","workspaceId","createdAt","updatedAt","createdBy","updatedBy","reason","audits"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","severity":"Low","category":"Onboarding","type":"AML Screening","status":"Open","name":"Jane Doe","description":"Example description","assignedTo":"example","seen":true,"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","reason":"Manual review required","workflowSessionId":"example","notes":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","name":"Jane Doe","description":"Example description","data":{},"cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","documents":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","objectKey":"3b241101-e2bb-4255-8caf-4136c566a962","filename":"Jane Doe","mimetype":"DEFAULT","description":"Example description","cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","presignedUrl":"https://example.com/resource"}]}],"audits":[{"timestamp":"2024-05-14T09:30:00.000Z","action":"create","author":"example","record":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","severity":"Low","category":"Onboarding","type":"AML Screening","status":"Open","name":"Jane Doe","description":"Example description","assignedTo":"example","seen":true,"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","reason":"Manual review required","workflowSessionId":"example","notes":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","name":"Jane Doe","description":"Example description","data":{},"cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","documents":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","objectKey":"3b241101-e2bb-4255-8caf-4136c566a962","filename":"Jane Doe","mimetype":"DEFAULT","description":"Example description","cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","presignedUrl":"https://example.com/resource"}]}]}}],"complyAdvantageData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","searchId":42,"searchRef":"example","searchResult":{"client_ref":"example","id":42,"ref":"example","searcher_id":42,"assignee_id":42,"filters":{"types":["sanction"],"birth_year":2024,"remove_deceased":1,"entity_type":"person","country_codes":["AN"]},"match_status":"unknown","risk_level":"low","search_term":"example","submitted_term":"example","total_hits":42,"total_matches":42,"total_blacklist_hits":42,"created_at":"2024-05-14T09:30:00.000Z","updated_at":"2024-05-14T09:30:00.000Z","tags":[{"exampleKey":"vip"}],"labels":[{}],"limit":42,"offset":42,"searcher":{"id":42,"email":"jane.doe@example.com","name":"Jane Doe","phone":"+4915112345678","created_at":"2024-05-14T09:30:00.000Z","user_is_active":true},"assignee":{"id":42,"email":"jane.doe@example.com","name":"Jane Doe","phone":"+4915112345678","created_at":"2024-05-14T09:30:00.000Z","user_is_active":true},"hits":[{"doc":{"id":"example","last_updated_utc":"2024-05-14T09:30:00.000Z","created_utc":"2024-05-14T09:30:00.000Z","fields":[{"name":"Jane Doe","source":"example","value":"example","locale":"example","tag":"vip"}],"types":["sanction"],"name":"Jane Doe","entity_type":"person","aka":[{"name":"Jane Doe"}],"associates":[{"association":"example","name":"Jane Doe"}],"sources":["example"],"keywords":[{}],"media":[{"date":"2024-05-14T09:30:00.000Z","snippet":"example","title":"Example title","url":"https://example.com/resource"}],"source_notes":{}},"match_types":["DEFAULT"],"match_types_details":[{"aml_types":[],"matching_name":"Jane Doe","name_matches":[],"secondary_matches":[],"sources":[]}],"match_status":"ACTIVE","is_whitelisted":true,"score":42}],"blacklist_hits":[{}]},"searchEntities":[{"id":"example","last_updated_utc":"2024-05-14T09:30:00.000Z","created_utc":"2024-05-14T09:30:00.000Z","key_information":{"name":"Jane Doe","entity_type":"person","types":["sanction"],"grouped_types":[{"type":"sanction"}],"match_types":["DEFAULT"],"sources":["example"],"source_notes":{},"aka":[{"name":"Jane Doe"}],"date_of_birth":"example","dates_of_birth":["example"],"match_status":"unknown","risk_level":"low","is_whitelisted":true,"age":42,"death_age":{},"date_of_death":{},"primary_country":{},"country_names":"example","designation":"example","associates":[{"association":"example","name":"Jane Doe"}]},"uncategorized":{"keywords":[{}],"media":[{"date":"2024-05-14T09:30:00.000Z","snippet":"example","title":"Example title","url":"https://example.com/resource"}],"assets":[{}],"match_types":["DEFAULT"],"related":[{}],"fields":[{}]},"full_listing":{"exampleKey":{"exampleKey":{"aml_types":["DEFAULT"],"count":42,"country_codes":["example"],"data":[{"name":"Jane Doe","source":"example","value":"example"}],"disclose_sources":true,"listing_ended_utc":"example","listing_started_utc":"example","name":"Jane Doe","source":"example","url":"https://example.com/resource"}}},"navigation":{"next":{},"previous":{}}}],"requestData":{"search_term":"example","client_ref":"example","search_profile":"example","fuzziness":1,"offset":42,"limit":42,"filters":{"types":["sanction"],"birth_year":2024,"remove_deceased":1,"entity_type":"person","country_codes":["AN"]},"tags":[{"exampleKey":"vip"}],"share_url":1,"exact_match":true},"executionId":"example","alertId":"3b241101-e2bb-4255-8caf-4136c566a962","workflowSessionId":"example","isMonitored":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}],"duplicateData":[{"original":{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","customerInfo":"example","profilePictureUrl":"https://example.com/resource","idDocumentUrl":"https://example.com/resource"},"duplicate":{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","customerInfo":"example","profilePictureUrl":"https://example.com/resource","idDocumentUrl":"https://example.com/resource"}}],"cmsScenarioId":"example","scenarioName":"Jane Doe","results":[{"data":{"AMLScreeningsResults":{"id":"example","@context":["example"],"type":["DEFAULT"],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"ProofOfResidence":{"id":"example","@context":["example"],"type":["DEFAULT"],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"IDScanSelfie":{"id":"example","@context":["example"],"type":["DEFAULT"],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"IDImage":{"id":"example","@context":["example"],"type":["DEFAULT"],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"IDInformation":{"id":"example","@context":["example"],"type":["DEFAULT"],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"SelfieImage":{"id":"example","@context":["example"],"type":["DEFAULT"],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"RulesEngineInputData":{"exampleKey":{}},"TFHEResult":"example"},"ruleData":{"queryId":"query_3b241101e2bb42558caf4136","id":"query_3b241101e2bb42558caf4136","requestId":42,"attribute":{"version":"v1","schema":"Customer","path":"example"},"secondaryAttribute":{"version":"v1","schema":"Customer","path":"example"},"value":true,"operator":"$noop","displayMode":"amount","timeframe":"daily","datasetColumnId":"datasetc_3b241101e2bb42558caf4136","sourceDatasetColumnId":"datasetc_3b241101e2bb42558caf4136","specialDataSetType":"ACTIVE_USERS_ADDRESSES"},"status":"valid","cmsScenarioId":"example","scenarioName":"Jane Doe","queryBlocksMergeOperator":"AND","queryGroupId":"example","queryGroupOperator":"AND","queryGroupIndex":42}],"transactions":[{"id":"tx_3b241101e2bb42558caf4136","transactionDate":"2024-05-14T09:30:00.000Z","transactionType":"crypto","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","transactionInfo":{"hash":"example","blockchainChainId":"example","direction":"IN","amount":"example","currencyCode":"example","hashUrl":"https://example.com/resource"},"transactionAmounts":[{"fieldName":"amount","currencyCode":"example","amount":"example"}],"transactionReview":{"riskLevel":"Low","status":"pending"},"originator":{"partyId":"example","name":"Jane Doe","type":"individual","transactionMethod":{"type":"card","accountId":"example"},"institution":{"name":"Jane Doe"},"address":{"country":"AFG"}},"beneficiary":{"partyId":"example","name":"Jane Doe","type":"individual","transactionMethod":{"type":"card","accountId":"example"},"institution":{"name":"Jane Doe"},"address":{"country":"AFG"}}}],"tagsToEntity":[{"id":"tte_3b241101e2bb42558caf4136","tagId":"example","entityId":"example","entityType":"transactionReview","createdBy":"workspace","tags":{"id":"tag_3b241101e2bb42558caf4136","type":"transaction","title":"Example title","backgroundColor":"example","textColor":"example","workspaceId":"example","organizationId":"example","deletedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}],"rulesMergeOperator":"AND"}}}},"default":{"$ref":"#/components/responses/error"}}},"patch":{"operationId":"alertsRouter-updateAlert","summary":"Update alert","description":"Partially update an existing alert (e.g. its status or attributes) by its alert id, within the caller's authorized scope. Only the supplied fields are modified.","tags":["Alerts"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"severity":{"type":"string","enum":["Low","Medium","High"]},"category":{"type":"string","enum":["Onboarding","Ongoing monitoring"]},"type":{"type":"string","enum":["AML Screening","IP Screening","Email Screening","KYC Drop-off","Onchain Monitoring","Fraud","Transaction Monitoring","Duplicate","Individual Monitoring","Compliance Review Required"]},"status":{"type":"string","enum":["Open","Under Investigation","Pending","Closed","Escalated"]},"name":{"type":"string"},"description":{"type":"string","nullable":true},"assignedTo":{"type":"string","nullable":true},"seen":{"type":"boolean"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true},"workflowSessionId":{"type":"string","nullable":true}},"additionalProperties":false},"example":{"severity":"Low","category":"Onboarding","type":"AML Screening","status":"Open","name":"Jane Doe","description":"Example description","assignedTo":"example","seen":true,"organizationId":"example","workspaceId":"example","reason":"Manual review required","workflowSessionId":"example"}}}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"severity":{"type":"string","enum":["Low","Medium","High"]},"category":{"type":"string","enum":["Onboarding","Ongoing monitoring"]},"type":{"type":"string","enum":["AML Screening","IP Screening","Email Screening","KYC Drop-off","Onchain Monitoring","Fraud","Transaction Monitoring","Duplicate","Individual Monitoring","Compliance Review Required"]},"status":{"type":"string","enum":["Open","Under Investigation","Pending","Closed","Escalated"]},"name":{"type":"string"},"description":{"type":"string","nullable":true},"assignedTo":{"type":"string","nullable":true},"seen":{"type":"boolean"},"customerId":{"type":"string","format":"uuid"},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"reason":{"type":"string","nullable":true},"workflowSessionId":{"type":"string","nullable":true},"notes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"data":{},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"objectKey":{"type":"string","format":"uuid"},"filename":{"type":"string"},"mimetype":{"type":"string"},"description":{"type":"string","nullable":true},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"presignedUrl":{"type":"string"}},"required":["id","objectKey","filename","mimetype","description","cmsProjectId","organizationId","workspaceId","createdAt","createdBy","presignedUrl"],"additionalProperties":false}}},"required":["id","name","description","cmsProjectId","organizationId","workspaceId","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"complyAdvantageData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid","nullable":true},"searchId":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"nullable":true},"searchRef":{"type":"string","nullable":true},"searchResult":{"type":"object","properties":{"client_ref":{"type":"string"},"id":{"type":"number"},"ref":{"type":"string"},"searcher_id":{"type":"number"},"assignee_id":{"type":"number"},"filters":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]},"nullable":true},"birth_year":{"type":"number","nullable":true},"remove_deceased":{"type":"number","minimum":0,"maximum":1,"nullable":true},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"],"nullable":true},"country_codes":{"type":"array","items":{"type":"string","enum":["AN","XK","AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"nullable":true}},"additionalProperties":false},"match_status":{"type":"string","enum":["unknown","no_match","potential_match","false_positive","true_positive","true_positive_approve","true_positive_reject"]},"risk_level":{"type":"string","enum":["low","medium","high","unknown"]},"search_term":{"type":"string"},"submitted_term":{"type":"string"},"total_hits":{"type":"number"},"total_matches":{"type":"number"},"total_blacklist_hits":{"type":"number"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"tags":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"labels":{"type":"array","items":{}},"limit":{"type":"number"},"offset":{"type":"number"},"searcher":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string","format":"email"},"name":{"type":"string"},"phone":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"user_is_active":{"type":"boolean"}},"required":["id","email","name","phone","created_at","user_is_active"],"additionalProperties":false},"assignee":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string","format":"email"},"name":{"type":"string"},"phone":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"user_is_active":{"type":"boolean"}},"required":["id","email","name","phone","created_at","user_is_active"],"additionalProperties":false},"hits":{"type":"array","items":{"type":"object","properties":{"doc":{"type":"object","properties":{"id":{"type":"string"},"last_updated_utc":{"type":"string","format":"date-time"},"created_utc":{"type":"string","format":"date-time"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"source":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"},"tag":{"type":"string"}},"required":["name","value"],"additionalProperties":false}},"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]}},"name":{"type":"string"},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"]},"aka":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false}},"associates":{"type":"array","items":{"type":"object","properties":{"association":{"type":"string"},"name":{"type":"string"}},"required":["association","name"],"additionalProperties":false}},"sources":{"type":"array","items":{"type":"string"}},"keywords":{"type":"array","items":{}},"media":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"snippet":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["snippet","title","url"],"additionalProperties":false}},"source_notes":{}},"required":["id","last_updated_utc","created_utc","types","name","entity_type","aka","sources","keywords"],"additionalProperties":false},"match_types":{"type":"array","items":{"type":"string"}},"match_types_details":{"type":"array","items":{"type":"object","properties":{"aml_types":{"type":"array","items":{"type":"string"}},"matching_name":{"type":"string"},"name_matches":{"type":"array","items":{"type":"object","properties":{"match_types":{"type":"array","items":{"type":"string"}},"query_term":{"type":"string"}},"required":["match_types","query_term"],"additionalProperties":false}},"secondary_matches":{"type":"array","items":{}},"sources":{"type":"array","items":{"type":"string"}}},"required":["aml_types","matching_name","name_matches","secondary_matches","sources"],"additionalProperties":false}},"match_status":{"type":"string"},"is_whitelisted":{"type":"boolean"},"score":{"type":"number"}},"required":["doc","match_types","match_types_details","match_status","is_whitelisted","score"],"additionalProperties":false}},"blacklist_hits":{"type":"array","items":{}}},"required":["client_ref","id","ref","searcher_id","assignee_id","match_status","risk_level","search_term","submitted_term","total_hits","total_matches","total_blacklist_hits","created_at","updated_at","labels","limit","offset"],"additionalProperties":false},"searchEntities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"last_updated_utc":{"type":"string","format":"date-time"},"created_utc":{"type":"string","format":"date-time"},"key_information":{"type":"object","properties":{"name":{"type":"string"},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"]},"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]},"nullable":true},"grouped_types":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]}},"required":["type"],"additionalProperties":false},"nullable":true},"match_types":{"type":"array","items":{"type":"string"},"nullable":true},"sources":{"type":"array","items":{"type":"string"},"nullable":true},"source_notes":{"nullable":true},"aka":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false},"nullable":true},"date_of_birth":{"type":"string","nullable":true},"dates_of_birth":{"type":"array","items":{"type":"string"},"nullable":true},"match_status":{"type":"string","enum":["unknown","no_match","potential_match","false_positive","true_positive","true_positive_approve","true_positive_reject"],"nullable":true},"risk_level":{"type":"string","enum":["low","medium","high","unknown"],"nullable":true},"is_whitelisted":{"type":"boolean","nullable":true},"age":{"type":"number","nullable":true},"death_age":{"nullable":true},"date_of_death":{"nullable":true},"primary_country":{"nullable":true},"country_names":{"type":"string","nullable":true},"designation":{"type":"string","nullable":true},"associates":{"type":"array","items":{"type":"object","properties":{"association":{"type":"string"},"name":{"type":"string"}},"required":["association","name"],"additionalProperties":false},"nullable":true}},"required":["name","entity_type"],"additionalProperties":false,"nullable":true},"uncategorized":{"type":"object","properties":{"keywords":{"type":"array","items":{},"nullable":true},"media":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"snippet":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["snippet","title","url"],"additionalProperties":false},"nullable":true},"assets":{"type":"array","items":{},"nullable":true},"match_types":{"type":"array","items":{"type":"string"},"nullable":true},"related":{"type":"array","items":{},"nullable":true},"fields":{"type":"array","items":{},"nullable":true}},"additionalProperties":false,"nullable":true},"full_listing":{"type":"object","additionalProperties":{"anyOf":[{"not":{}},{"type":"object","additionalProperties":{"anyOf":[{"not":{}},{"type":"object","properties":{"aml_types":{"type":"array","items":{"type":"string"},"nullable":true},"count":{"type":"number","nullable":true},"country_codes":{"type":"array","items":{"type":"string"},"nullable":true},"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"disclose_sources":{"type":"boolean","nullable":true},"listing_ended_utc":{"type":"string","nullable":true},"listing_started_utc":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"url":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true}]},"nullable":true}]},"nullable":true},"navigation":{"type":"object","properties":{"next":{"nullable":true},"previous":{"nullable":true}},"additionalProperties":false,"nullable":true}},"required":["id","last_updated_utc","created_utc"],"additionalProperties":false},"nullable":true},"requestData":{"type":"object","properties":{"search_term":{"type":"string","description":"represents name of the entity"},"client_ref":{"type":"string","description":"Your reference for this person/entity for which you are searching. Used for tracking searches and auto-whitelisting recurring results"},"search_profile":{"type":"string","nullable":true,"description":"The Profile ID of a search profile that can be retrieved from the UI"},"fuzziness":{"type":"number","minimum":0,"maximum":1,"nullable":true,"description":"determines how closely the returned results must match the supplied name. Overridden by exact_match"},"offset":{"type":"number","nullable":true,"description":"match results from the database, starting form the offset value"},"limit":{"type":"number","nullable":true,"description":"math results from the database, taking up this many matches each search"},"filters":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]},"nullable":true},"birth_year":{"type":"number","nullable":true},"remove_deceased":{"type":"number","minimum":0,"maximum":1,"nullable":true},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"],"nullable":true},"country_codes":{"type":"array","items":{"type":"string","enum":["AN","XK","AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"nullable":true}},"additionalProperties":false,"description":"specify filters within the search to narrow down the results"},"tags":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}},"nullable":true,"description":"name => value pairs, to search later using defined tags here"},"share_url":{"type":"number","minimum":0,"maximum":1,"nullable":true,"description":"include a shareable URL to access search publicly"},"exact_match":{"type":"boolean","nullable":true,"description":"Exact match disables all standard and optional matching behaviours (Honorifics, affixes, initials, glued name, name variation, equivalent names, extra words in entity,...) 0% fuzziness disables 1 letter typo matching but keeps all other matching behaviours (standard and optional)"}},"required":["search_term","client_ref"],"additionalProperties":false},"executionId":{"type":"string"},"alertId":{"type":"string","format":"uuid","nullable":true},"workflowSessionId":{"type":"string","nullable":true},"isMonitored":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","searchId","searchRef","searchResult","requestData","executionId","alertId","isMonitored","createdAt","updatedAt"],"additionalProperties":false},"nullable":true},"duplicateData":{"type":"array","items":{"type":"object","properties":{"original":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"customerInfo":{"type":"string","nullable":true},"profilePictureUrl":{"type":"string","nullable":true},"idDocumentUrl":{"type":"string","nullable":true}},"required":["customerId"],"additionalProperties":false},"duplicate":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"customerInfo":{"type":"string","nullable":true},"profilePictureUrl":{"type":"string","nullable":true},"idDocumentUrl":{"type":"string","nullable":true}},"required":["customerId"],"additionalProperties":false}},"required":["original","duplicate"],"additionalProperties":false},"nullable":true},"cmsScenarioId":{"type":"string","nullable":true},"scenarioName":{"type":"string","nullable":true},"results":{"type":"array","items":{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"AMLScreeningsResults":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"ProofOfResidence":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDScanSelfie":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDImage":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDInformation":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"SelfieImage":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"RulesEngineInputData":{"type":"object","additionalProperties":{},"nullable":true},"TFHEResult":{"type":"string","nullable":true}},"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"typ":{"type":"string","enum":["application/iden3-zkp-json","application/iden3comm-plain-json","application/iden3comm-signed-json"]},"type":{"type":"string","enum":["https://iden3-communication.io/authorization/1.0/request","https://iden3-communication.io/authorization/1.0/response","https://iden3-communication.io/credentials/1.0/issuance-request","https://iden3-communication.io/credentials/1.0/fetch-request","https://iden3-communication.io/credentials/1.0/offer","https://iden3-communication.io/credentials/1.0/issuance-response","https://iden3-communication.io/credentials/1.0/refresh","https://iden3-communication.io/devices/1.0/registration","https://iden3-communication.io/messages/1.0/fetch","https://iden3-communication.io/proofs/1.0/request","https://iden3-communication.io/proofs/1.0/response","https://iden3-communication.io/revocation/1.0/request-status","https://iden3-communication.io/revocation/1.0/status","https://iden3-communication.io/proofs/1.0/contract-invoke-request","https://iden3-communication.io/proofs/1.0/contract-invoke-response","https://iden3-communication.io/credentials/1.0/onchain-offer","https://iden3-communication.io/credentials/0.1/proposal-request","https://iden3-communication.io/credentials/0.1/proposal","https://iden3-communication.io/credentials/0.1/payment-request","https://iden3-communication.io/credentials/0.1/payment"]},"thid":{"type":"string"},"body":{"type":"object","properties":{"callbackUrl":{"type":"string"},"reason":{"type":"string"},"did_doc":{},"message":{"type":"string"},"scope":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"number"},{"type":"string"}]},"circuitId":{"type":"string"},"optional":{"type":"boolean"},"query":{"type":"object","additionalProperties":{}}},"required":["id","circuitId","query"],"additionalProperties":false}}},"required":["callbackUrl","scope"],"additionalProperties":false},"from":{"type":"string"},"to":{"type":"string"}},"required":["id","type","body","from"],"additionalProperties":false}],"nullable":true},"ruleData":{"type":"object","properties":{"queryId":{"description":"Unique ID for the query"},"id":{"description":"Unique ID for the query"},"requestId":{"type":"number","nullable":true,"description":"Request ID for ZKPs"},"attribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"],"additionalProperties":false},"secondaryAttribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"],"additionalProperties":false,"nullable":true},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"number"}}],"nullable":true},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"displayMode":{"type":"string","enum":["amount","percentage"],"nullable":true},"timeframe":{"type":"string","enum":["daily","weekly","monthly","yearly"],"nullable":true},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","enum":["ACTIVE_USERS_ADDRESSES"],"nullable":true}},"required":["attribute","operator"],"additionalProperties":false,"nullable":true},"status":{"type":"string","enum":["valid","not-valid","skipped","error","unknown"],"nullable":true},"cmsScenarioId":{"type":"string","nullable":true},"scenarioName":{"type":"string","nullable":true},"queryBlocksMergeOperator":{"type":"string","enum":["AND","OR"],"nullable":true},"queryGroupId":{"type":"string","nullable":true},"queryGroupOperator":{"type":"string","enum":["AND","OR"],"nullable":true},"queryGroupIndex":{"type":"number","nullable":true}},"additionalProperties":false},"nullable":true},"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"nullable":true},"transactionDate":{"type":"string","format":"date-time","nullable":true},"transactionType":{"type":"string","enum":["crypto","fiat"],"nullable":true},"customerId":{"type":"string","format":"uuid","nullable":true},"transactionInfo":{"type":"object","properties":{"hash":{"type":"string","nullable":true},"blockchainChainId":{"type":"string","nullable":true},"direction":{"type":"string","enum":["IN","OUT","EXCHANGE"],"nullable":true},"amount":{"type":"string","nullable":true},"currencyCode":{"type":"string","nullable":true},"hashUrl":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"transactionAmounts":{"type":"array","items":{"type":"object","properties":{"fieldName":{"type":"string","enum":["amount","targetAmount","networkFeeAmount","platformFeeAmount","transactionFeeAmount"],"nullable":true},"currencyCode":{"type":"string","nullable":true},"amount":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"transactionReview":{"type":"object","properties":{"riskLevel":{"type":"string","enum":["Low","Medium","High","No risk"],"nullable":true},"status":{"type":"string","enum":["pending","approved","under_investigation","blocked","failed"],"nullable":true}},"additionalProperties":false,"nullable":true},"originator":{"type":"object","properties":{"partyId":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["individual","company","smart-contract"],"nullable":true},"transactionMethod":{"type":"object","properties":{"type":{"type":"string","enum":["card","account","crypto"],"nullable":true},"accountId":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"institution":{"type":"object","properties":{"name":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"address":{"type":"object","properties":{"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true}},"additionalProperties":false,"nullable":true}},"additionalProperties":false,"nullable":true},"beneficiary":{"type":"object","properties":{"partyId":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["individual","company","smart-contract"],"nullable":true},"transactionMethod":{"type":"object","properties":{"type":{"type":"string","enum":["card","account","crypto"],"nullable":true},"accountId":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"institution":{"type":"object","properties":{"name":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"address":{"type":"object","properties":{"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true}},"additionalProperties":false,"nullable":true}},"additionalProperties":false,"nullable":true}},"additionalProperties":false},"nullable":true},"tagsToEntity":{"type":"array","items":{"type":"object","properties":{"id":{},"tagId":{"type":"string"},"entityId":{"type":"string"},"entityType":{"type":"string","enum":["transactionReview","customer","alert","wallet"]},"createdBy":{"type":"string","nullable":true},"tags":{"type":"object","properties":{"id":{},"type":{"type":"string","enum":["transaction","individual","company","wallet"]},"title":{"type":"string"},"backgroundColor":{"type":"string"},"textColor":{"type":"string"},"workspaceId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"deletedAt":{"type":"string","format":"date-time","nullable":true},"createdBy":{"type":"string","nullable":true},"updatedBy":{"type":"string","nullable":true}},"required":["id","type","title","backgroundColor","textColor","workspaceId"],"additionalProperties":false}},"required":["id","tagId","entityId","entityType","tags"],"additionalProperties":false},"nullable":true},"rulesMergeOperator":{"type":"string","enum":["AND","OR"],"nullable":true}},"required":["id","severity","category","type","status","name","description","assignedTo","seen","customerId","cmsProjectId","organizationId","workspaceId","createdAt","updatedAt","createdBy","updatedBy","reason"],"additionalProperties":false},"example":{"id":"3b241101-e2bb-4255-8caf-4136c566a962","severity":"Low","category":"Onboarding","type":"AML Screening","status":"Open","name":"Jane Doe","description":"Example description","assignedTo":"example","seen":true,"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","reason":"Manual review required","workflowSessionId":"example","notes":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","name":"Jane Doe","description":"Example description","data":{},"cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","documents":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","objectKey":"3b241101-e2bb-4255-8caf-4136c566a962","filename":"Jane Doe","mimetype":"DEFAULT","description":"Example description","cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","presignedUrl":"https://example.com/resource"}]}],"complyAdvantageData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","searchId":42,"searchRef":"example","searchResult":{"client_ref":"example","id":42,"ref":"example","searcher_id":42,"assignee_id":42,"filters":{"types":["sanction"],"birth_year":2024,"remove_deceased":1,"entity_type":"person","country_codes":["AN"]},"match_status":"unknown","risk_level":"low","search_term":"example","submitted_term":"example","total_hits":42,"total_matches":42,"total_blacklist_hits":42,"created_at":"2024-05-14T09:30:00.000Z","updated_at":"2024-05-14T09:30:00.000Z","tags":[{"exampleKey":"vip"}],"labels":[{}],"limit":42,"offset":42,"searcher":{"id":42,"email":"jane.doe@example.com","name":"Jane Doe","phone":"+4915112345678","created_at":"2024-05-14T09:30:00.000Z","user_is_active":true},"assignee":{"id":42,"email":"jane.doe@example.com","name":"Jane Doe","phone":"+4915112345678","created_at":"2024-05-14T09:30:00.000Z","user_is_active":true},"hits":[{"doc":{"id":"example","last_updated_utc":"2024-05-14T09:30:00.000Z","created_utc":"2024-05-14T09:30:00.000Z","fields":[{"name":"Jane Doe","source":"example","value":"example","locale":"example","tag":"vip"}],"types":["sanction"],"name":"Jane Doe","entity_type":"person","aka":[{"name":"Jane Doe"}],"associates":[{"association":"example","name":"Jane Doe"}],"sources":["example"],"keywords":[{}],"media":[{"date":"2024-05-14T09:30:00.000Z","snippet":"example","title":"Example title","url":"https://example.com/resource"}],"source_notes":{}},"match_types":["DEFAULT"],"match_types_details":[{"aml_types":[],"matching_name":"Jane Doe","name_matches":[],"secondary_matches":[],"sources":[]}],"match_status":"ACTIVE","is_whitelisted":true,"score":42}],"blacklist_hits":[{}]},"searchEntities":[{"id":"example","last_updated_utc":"2024-05-14T09:30:00.000Z","created_utc":"2024-05-14T09:30:00.000Z","key_information":{"name":"Jane Doe","entity_type":"person","types":["sanction"],"grouped_types":[{"type":"sanction"}],"match_types":["DEFAULT"],"sources":["example"],"source_notes":{},"aka":[{"name":"Jane Doe"}],"date_of_birth":"example","dates_of_birth":["example"],"match_status":"unknown","risk_level":"low","is_whitelisted":true,"age":42,"death_age":{},"date_of_death":{},"primary_country":{},"country_names":"example","designation":"example","associates":[{"association":"example","name":"Jane Doe"}]},"uncategorized":{"keywords":[{}],"media":[{"date":"2024-05-14T09:30:00.000Z","snippet":"example","title":"Example title","url":"https://example.com/resource"}],"assets":[{}],"match_types":["DEFAULT"],"related":[{}],"fields":[{}]},"full_listing":{"exampleKey":{"exampleKey":{"aml_types":["DEFAULT"],"count":42,"country_codes":["example"],"data":[{"name":"Jane Doe","source":"example","value":"example"}],"disclose_sources":true,"listing_ended_utc":"example","listing_started_utc":"example","name":"Jane Doe","source":"example","url":"https://example.com/resource"}}},"navigation":{"next":{},"previous":{}}}],"requestData":{"search_term":"example","client_ref":"example","search_profile":"example","fuzziness":1,"offset":42,"limit":42,"filters":{"types":["sanction"],"birth_year":2024,"remove_deceased":1,"entity_type":"person","country_codes":["AN"]},"tags":[{"exampleKey":"vip"}],"share_url":1,"exact_match":true},"executionId":"example","alertId":"3b241101-e2bb-4255-8caf-4136c566a962","workflowSessionId":"example","isMonitored":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}],"duplicateData":[{"original":{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","customerInfo":"example","profilePictureUrl":"https://example.com/resource","idDocumentUrl":"https://example.com/resource"},"duplicate":{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","customerInfo":"example","profilePictureUrl":"https://example.com/resource","idDocumentUrl":"https://example.com/resource"}}],"cmsScenarioId":"example","scenarioName":"Jane Doe","results":[{"data":{"AMLScreeningsResults":{"id":"example","@context":["example"],"type":["DEFAULT"],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"ProofOfResidence":{"id":"example","@context":["example"],"type":["DEFAULT"],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"IDScanSelfie":{"id":"example","@context":["example"],"type":["DEFAULT"],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"IDImage":{"id":"example","@context":["example"],"type":["DEFAULT"],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"IDInformation":{"id":"example","@context":["example"],"type":["DEFAULT"],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"SelfieImage":{"id":"example","@context":["example"],"type":["DEFAULT"],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"RulesEngineInputData":{"exampleKey":{}},"TFHEResult":"example"},"ruleData":{"queryId":"query_3b241101e2bb42558caf4136","id":"query_3b241101e2bb42558caf4136","requestId":42,"attribute":{"version":"v1","schema":"Customer","path":"example"},"secondaryAttribute":{"version":"v1","schema":"Customer","path":"example"},"value":true,"operator":"$noop","displayMode":"amount","timeframe":"daily","datasetColumnId":"datasetc_3b241101e2bb42558caf4136","sourceDatasetColumnId":"datasetc_3b241101e2bb42558caf4136","specialDataSetType":"ACTIVE_USERS_ADDRESSES"},"status":"valid","cmsScenarioId":"example","scenarioName":"Jane Doe","queryBlocksMergeOperator":"AND","queryGroupId":"example","queryGroupOperator":"AND","queryGroupIndex":42}],"transactions":[{"id":"tx_3b241101e2bb42558caf4136","transactionDate":"2024-05-14T09:30:00.000Z","transactionType":"crypto","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","transactionInfo":{"hash":"example","blockchainChainId":"example","direction":"IN","amount":"example","currencyCode":"example","hashUrl":"https://example.com/resource"},"transactionAmounts":[{"fieldName":"amount","currencyCode":"example","amount":"example"}],"transactionReview":{"riskLevel":"Low","status":"pending"},"originator":{"partyId":"example","name":"Jane Doe","type":"individual","transactionMethod":{"type":"card","accountId":"example"},"institution":{"name":"Jane Doe"},"address":{"country":"AFG"}},"beneficiary":{"partyId":"example","name":"Jane Doe","type":"individual","transactionMethod":{"type":"card","accountId":"example"},"institution":{"name":"Jane Doe"},"address":{"country":"AFG"}}}],"tagsToEntity":[{"id":"tte_3b241101e2bb42558caf4136","tagId":"example","entityId":"example","entityType":"transactionReview","createdBy":"workspace","tags":{"id":"tag_3b241101e2bb42558caf4136","type":"transaction","title":"Example title","backgroundColor":"example","textColor":"example","workspaceId":"example","organizationId":"example","deletedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}],"rulesMergeOperator":"AND"}}}},"default":{"$ref":"#/components/responses/error"}}},"delete":{"operationId":"alertsRouter-deleteAlert","summary":"Delete alert","description":"Delete an alert by its alert id, within the caller's authorized scope. This permanently removes the alert record; use with care.","tags":["Alerts"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}}},"default":{"$ref":"#/components/responses/error"}}}},"/alerts/grouped/{id}":{"patch":{"operationId":"alertsRouter-updateMetaAlert","summary":"Update grouped alert","description":"Update a grouped alert by its ID.","tags":["Alerts"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["Open","Under Investigation","Pending","Closed","Escalated"]},"severity":{"type":"string","enum":["Low","Medium","High"]},"reason":{"type":"string","nullable":true}},"additionalProperties":false},"example":{"status":"Open","severity":"Low","reason":"Manual review required"}}}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"example"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["Open","Under Investigation","Pending","Closed","Escalated"]},"severity":{"type":"string","enum":["Low","Medium","High"]},"updatedBy":{"type":"string","nullable":true},"reason":{"type":"string","nullable":true}},"required":["id","name","status","severity","updatedBy","reason"],"additionalProperties":false},"example":{"id":"example","name":"Jane Doe","status":"Open","severity":"Low","updatedBy":"workspace","reason":"Manual review required"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/add-note-to-alert":{"post":{"operationId":"alertsRouter-addNoteToAlert","summary":"Add note to alert","description":"Add a note to an alert.","tags":["Alerts"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"noteId":{"type":"string","format":"uuid"},"alertId":{"type":"string","format":"uuid"}},"required":["noteId","alertId"],"additionalProperties":false},"example":{"noteId":"3b241101-e2bb-4255-8caf-4136c566a962","alertId":"3b241101-e2bb-4255-8caf-4136c566a962"}}}},"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}}},"default":{"$ref":"#/components/responses/error"}}}},"/remove-note-from-alert":{"post":{"operationId":"alertsRouter-removeNoteFromAlert","summary":"Remove note from alert","description":"Remove a note from an alert.","tags":["Alerts"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"alertId":{"type":"string","format":"uuid"},"noteId":{"type":"string","format":"uuid"}},"required":["alertId","noteId"],"additionalProperties":false},"example":{"alertId":"3b241101-e2bb-4255-8caf-4136c566a962","noteId":"3b241101-e2bb-4255-8caf-4136c566a962"}}}},"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}}},"default":{"$ref":"#/components/responses/error"}}}},"/compliance/projects/{projectId}/alerts":{"get":{"operationId":"alertsRouter-getAlertsForWorkspace","summary":"Get alerts for workspace","description":"Get all alerts for a workspace.","tags":["Alerts"],"security":[{"Authorization":[]}],"parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"},"example":"example"},{"name":"alertType","in":"query","required":false,"schema":{"type":"string","enum":["AML Screening","IP Screening","Email Screening","KYC Drop-off","Onchain Monitoring","Fraud","Transaction Monitoring","Duplicate","Individual Monitoring","Compliance Review Required"]},"example":"AML Screening"},{"name":"alertStatus","in":"query","required":false,"schema":{"type":"string","enum":["Open","Under Investigation","Pending","Closed","Escalated"]},"example":"Open"},{"name":"alertSeverity","in":"query","required":false,"schema":{"type":"string","enum":["Low","Medium","High"]},"example":"Low"},{"name":"currentPage","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"number"}],"default":0},"example":0},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"number"}],"default":10},"example":10},{"name":"category","in":"query","required":false,"schema":{"type":"string","enum":["Onboarding","Ongoing monitoring"]},"example":"Onboarding"},{"name":"assignedTo","in":"query","required":false,"schema":{"type":"string"},"example":"example"},{"name":"search","in":"query","required":false,"schema":{"type":"string"},"example":"example"},{"name":"customerType","in":"query","required":false,"schema":{"type":"string","enum":["Individual","Company"]},"example":"Individual"},{"name":"groupByMetaAlerts","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"boolean"}],"default":false},"example":false}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"totalCount":{"type":"number"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"type":{"type":"string"},"status":{"type":"string","enum":["Open","Under Investigation","Pending","Closed","Escalated"]},"severity":{"type":"string","enum":["Low","Medium","High"]},"customerId":{"type":"string"},"managersCount":{"type":"number"},"scenarioAlertCount":{"type":"number","nullable":true},"workflowSessionId":{"type":"string","nullable":true},"workflowId":{"type":"string","nullable":true},"workflowName":{"type":"string","nullable":true},"workflowType":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"subAlerts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"severity":{"type":"string","enum":["Low","Medium","High"]},"category":{"type":"string","enum":["Onboarding","Ongoing monitoring"]},"type":{"type":"string","enum":["AML Screening","IP Screening","Email Screening","KYC Drop-off","Onchain Monitoring","Fraud","Transaction Monitoring","Duplicate","Individual Monitoring","Compliance Review Required"]},"status":{"type":"string","enum":["Open","Under Investigation","Pending","Closed","Escalated"]},"name":{"type":"string"},"description":{"type":"string","nullable":true},"assignedTo":{"type":"string","nullable":true},"seen":{"type":"boolean"},"customerId":{"type":"string","format":"uuid"},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"reason":{"type":"string","nullable":true},"workflowSessionId":{"type":"string","nullable":true},"notes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"data":{},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"objectKey":{"type":"string","format":"uuid"},"filename":{"type":"string"},"mimetype":{"type":"string"},"description":{"type":"string","nullable":true},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"presignedUrl":{"type":"string"}},"required":["id","objectKey","filename","mimetype","description","cmsProjectId","organizationId","workspaceId","createdAt","createdBy","presignedUrl"],"additionalProperties":false}}},"required":["id","name","description","cmsProjectId","organizationId","workspaceId","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"complyAdvantageData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid","nullable":true},"searchId":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"nullable":true},"searchRef":{"type":"string","nullable":true},"searchResult":{"type":"object","properties":{"client_ref":{"type":"string"},"id":{"type":"number"},"ref":{"type":"string"},"searcher_id":{"type":"number"},"assignee_id":{"type":"number"},"filters":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]},"nullable":true},"birth_year":{"type":"number","nullable":true},"remove_deceased":{"type":"number","minimum":0,"maximum":1,"nullable":true},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"],"nullable":true},"country_codes":{"type":"array","items":{"type":"string","enum":["AN","XK","AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"nullable":true}},"additionalProperties":false},"match_status":{"type":"string","enum":["unknown","no_match","potential_match","false_positive","true_positive","true_positive_approve","true_positive_reject"]},"risk_level":{"type":"string","enum":["low","medium","high","unknown"]},"search_term":{"type":"string"},"submitted_term":{"type":"string"},"total_hits":{"type":"number"},"total_matches":{"type":"number"},"total_blacklist_hits":{"type":"number"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"tags":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"labels":{"type":"array","items":{}},"limit":{"type":"number"},"offset":{"type":"number"},"searcher":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string","format":"email"},"name":{"type":"string"},"phone":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"user_is_active":{"type":"boolean"}},"required":["id","email","name","phone","created_at","user_is_active"],"additionalProperties":false},"assignee":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string","format":"email"},"name":{"type":"string"},"phone":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"user_is_active":{"type":"boolean"}},"required":["id","email","name","phone","created_at","user_is_active"],"additionalProperties":false},"hits":{"type":"array","items":{"type":"object","properties":{"doc":{"type":"object","properties":{"id":{"type":"string"},"last_updated_utc":{"type":"string","format":"date-time"},"created_utc":{"type":"string","format":"date-time"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"source":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"},"tag":{"type":"string"}},"required":["name","value"],"additionalProperties":false}},"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]}},"name":{"type":"string"},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"]},"aka":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false}},"associates":{"type":"array","items":{"type":"object","properties":{"association":{"type":"string"},"name":{"type":"string"}},"required":["association","name"],"additionalProperties":false}},"sources":{"type":"array","items":{"type":"string"}},"keywords":{"type":"array","items":{}},"media":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"snippet":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["snippet","title","url"],"additionalProperties":false}},"source_notes":{}},"required":["id","last_updated_utc","created_utc","types","name","entity_type","aka","sources","keywords"],"additionalProperties":false},"match_types":{"type":"array","items":{"type":"string"}},"match_types_details":{"type":"array","items":{"type":"object","properties":{"aml_types":{"type":"array","items":{"type":"string"}},"matching_name":{"type":"string"},"name_matches":{"type":"array","items":{"type":"object","properties":{"match_types":{"type":"array","items":{"type":"string"}},"query_term":{"type":"string"}},"required":["match_types","query_term"],"additionalProperties":false}},"secondary_matches":{"type":"array","items":{}},"sources":{"type":"array","items":{"type":"string"}}},"required":["aml_types","matching_name","name_matches","secondary_matches","sources"],"additionalProperties":false}},"match_status":{"type":"string"},"is_whitelisted":{"type":"boolean"},"score":{"type":"number"}},"required":["doc","match_types","match_types_details","match_status","is_whitelisted","score"],"additionalProperties":false}},"blacklist_hits":{"type":"array","items":{}}},"required":["client_ref","id","ref","searcher_id","assignee_id","match_status","risk_level","search_term","submitted_term","total_hits","total_matches","total_blacklist_hits","created_at","updated_at","labels","limit","offset"],"additionalProperties":false},"searchEntities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"last_updated_utc":{"type":"string","format":"date-time"},"created_utc":{"type":"string","format":"date-time"},"key_information":{"type":"object","properties":{"name":{"type":"string"},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"]},"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]},"nullable":true},"grouped_types":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]}},"required":["type"],"additionalProperties":false},"nullable":true},"match_types":{"type":"array","items":{"type":"string"},"nullable":true},"sources":{"type":"array","items":{"type":"string"},"nullable":true},"source_notes":{"nullable":true},"aka":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false},"nullable":true},"date_of_birth":{"type":"string","nullable":true},"dates_of_birth":{"type":"array","items":{"type":"string"},"nullable":true},"match_status":{"type":"string","enum":["unknown","no_match","potential_match","false_positive","true_positive","true_positive_approve","true_positive_reject"],"nullable":true},"risk_level":{"type":"string","enum":["low","medium","high","unknown"],"nullable":true},"is_whitelisted":{"type":"boolean","nullable":true},"age":{"type":"number","nullable":true},"death_age":{"nullable":true},"date_of_death":{"nullable":true},"primary_country":{"nullable":true},"country_names":{"type":"string","nullable":true},"designation":{"type":"string","nullable":true},"associates":{"type":"array","items":{"type":"object","properties":{"association":{"type":"string"},"name":{"type":"string"}},"required":["association","name"],"additionalProperties":false},"nullable":true}},"required":["name","entity_type"],"additionalProperties":false,"nullable":true},"uncategorized":{"type":"object","properties":{"keywords":{"type":"array","items":{},"nullable":true},"media":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"snippet":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["snippet","title","url"],"additionalProperties":false},"nullable":true},"assets":{"type":"array","items":{},"nullable":true},"match_types":{"type":"array","items":{"type":"string"},"nullable":true},"related":{"type":"array","items":{},"nullable":true},"fields":{"type":"array","items":{},"nullable":true}},"additionalProperties":false,"nullable":true},"full_listing":{"type":"object","additionalProperties":{"anyOf":[{"not":{}},{"type":"object","additionalProperties":{"anyOf":[{"not":{}},{"type":"object","properties":{"aml_types":{"type":"array","items":{"type":"string"},"nullable":true},"count":{"type":"number","nullable":true},"country_codes":{"type":"array","items":{"type":"string"},"nullable":true},"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"disclose_sources":{"type":"boolean","nullable":true},"listing_ended_utc":{"type":"string","nullable":true},"listing_started_utc":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"url":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true}]},"nullable":true}]},"nullable":true},"navigation":{"type":"object","properties":{"next":{"nullable":true},"previous":{"nullable":true}},"additionalProperties":false,"nullable":true}},"required":["id","last_updated_utc","created_utc"],"additionalProperties":false},"nullable":true},"requestData":{"type":"object","properties":{"search_term":{"type":"string","description":"represents name of the entity"},"client_ref":{"type":"string","description":"Your reference for this person/entity for which you are searching. Used for tracking searches and auto-whitelisting recurring results"},"search_profile":{"type":"string","nullable":true,"description":"The Profile ID of a search profile that can be retrieved from the UI"},"fuzziness":{"type":"number","minimum":0,"maximum":1,"nullable":true,"description":"determines how closely the returned results must match the supplied name. Overridden by exact_match"},"offset":{"type":"number","nullable":true,"description":"match results from the database, starting form the offset value"},"limit":{"type":"number","nullable":true,"description":"math results from the database, taking up this many matches each search"},"filters":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]},"nullable":true},"birth_year":{"type":"number","nullable":true},"remove_deceased":{"type":"number","minimum":0,"maximum":1,"nullable":true},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"],"nullable":true},"country_codes":{"type":"array","items":{"type":"string","enum":["AN","XK","AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"nullable":true}},"additionalProperties":false,"description":"specify filters within the search to narrow down the results"},"tags":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}},"nullable":true,"description":"name => value pairs, to search later using defined tags here"},"share_url":{"type":"number","minimum":0,"maximum":1,"nullable":true,"description":"include a shareable URL to access search publicly"},"exact_match":{"type":"boolean","nullable":true,"description":"Exact match disables all standard and optional matching behaviours (Honorifics, affixes, initials, glued name, name variation, equivalent names, extra words in entity,...) 0% fuzziness disables 1 letter typo matching but keeps all other matching behaviours (standard and optional)"}},"required":["search_term","client_ref"],"additionalProperties":false},"executionId":{"type":"string"},"alertId":{"type":"string","format":"uuid","nullable":true},"workflowSessionId":{"type":"string","nullable":true},"isMonitored":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","searchId","searchRef","searchResult","requestData","executionId","alertId","isMonitored","createdAt","updatedAt"],"additionalProperties":false},"nullable":true},"duplicateData":{"type":"array","items":{"type":"object","properties":{"original":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"customerInfo":{"type":"string","nullable":true},"profilePictureUrl":{"type":"string","nullable":true},"idDocumentUrl":{"type":"string","nullable":true}},"required":["customerId"],"additionalProperties":false},"duplicate":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"customerInfo":{"type":"string","nullable":true},"profilePictureUrl":{"type":"string","nullable":true},"idDocumentUrl":{"type":"string","nullable":true}},"required":["customerId"],"additionalProperties":false}},"required":["original","duplicate"],"additionalProperties":false},"nullable":true},"cmsScenarioId":{"type":"string","nullable":true},"scenarioName":{"type":"string","nullable":true},"results":{"type":"array","items":{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"AMLScreeningsResults":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"ProofOfResidence":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDScanSelfie":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDImage":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDInformation":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"SelfieImage":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"RulesEngineInputData":{"type":"object","additionalProperties":{},"nullable":true},"TFHEResult":{"type":"string","nullable":true}},"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"typ":{"type":"string","enum":["application/iden3-zkp-json","application/iden3comm-plain-json","application/iden3comm-signed-json"]},"type":{"type":"string","enum":["https://iden3-communication.io/authorization/1.0/request","https://iden3-communication.io/authorization/1.0/response","https://iden3-communication.io/credentials/1.0/issuance-request","https://iden3-communication.io/credentials/1.0/fetch-request","https://iden3-communication.io/credentials/1.0/offer","https://iden3-communication.io/credentials/1.0/issuance-response","https://iden3-communication.io/credentials/1.0/refresh","https://iden3-communication.io/devices/1.0/registration","https://iden3-communication.io/messages/1.0/fetch","https://iden3-communication.io/proofs/1.0/request","https://iden3-communication.io/proofs/1.0/response","https://iden3-communication.io/revocation/1.0/request-status","https://iden3-communication.io/revocation/1.0/status","https://iden3-communication.io/proofs/1.0/contract-invoke-request","https://iden3-communication.io/proofs/1.0/contract-invoke-response","https://iden3-communication.io/credentials/1.0/onchain-offer","https://iden3-communication.io/credentials/0.1/proposal-request","https://iden3-communication.io/credentials/0.1/proposal","https://iden3-communication.io/credentials/0.1/payment-request","https://iden3-communication.io/credentials/0.1/payment"]},"thid":{"type":"string"},"body":{"type":"object","properties":{"callbackUrl":{"type":"string"},"reason":{"type":"string"},"did_doc":{},"message":{"type":"string"},"scope":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"number"},{"type":"string"}]},"circuitId":{"type":"string"},"optional":{"type":"boolean"},"query":{"type":"object","additionalProperties":{}}},"required":["id","circuitId","query"],"additionalProperties":false}}},"required":["callbackUrl","scope"],"additionalProperties":false},"from":{"type":"string"},"to":{"type":"string"}},"required":["id","type","body","from"],"additionalProperties":false}],"nullable":true},"ruleData":{"type":"object","properties":{"queryId":{"description":"Unique ID for the query"},"id":{"description":"Unique ID for the query"},"requestId":{"type":"number","nullable":true,"description":"Request ID for ZKPs"},"attribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"],"additionalProperties":false},"secondaryAttribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"],"additionalProperties":false,"nullable":true},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"number"}}],"nullable":true},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"displayMode":{"type":"string","enum":["amount","percentage"],"nullable":true},"timeframe":{"type":"string","enum":["daily","weekly","monthly","yearly"],"nullable":true},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","enum":["ACTIVE_USERS_ADDRESSES"],"nullable":true}},"required":["attribute","operator"],"additionalProperties":false,"nullable":true},"status":{"type":"string","enum":["valid","not-valid","skipped","error","unknown"],"nullable":true},"cmsScenarioId":{"type":"string","nullable":true},"scenarioName":{"type":"string","nullable":true},"queryBlocksMergeOperator":{"type":"string","enum":["AND","OR"],"nullable":true},"queryGroupId":{"type":"string","nullable":true},"queryGroupOperator":{"type":"string","enum":["AND","OR"],"nullable":true},"queryGroupIndex":{"type":"number","nullable":true}},"additionalProperties":false},"nullable":true},"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"nullable":true},"transactionDate":{"type":"string","format":"date-time","nullable":true},"transactionType":{"type":"string","enum":["crypto","fiat"],"nullable":true},"customerId":{"type":"string","format":"uuid","nullable":true},"transactionInfo":{"type":"object","properties":{"hash":{"type":"string","nullable":true},"blockchainChainId":{"type":"string","nullable":true},"direction":{"type":"string","enum":["IN","OUT","EXCHANGE"],"nullable":true},"amount":{"type":"string","nullable":true},"currencyCode":{"type":"string","nullable":true},"hashUrl":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"transactionAmounts":{"type":"array","items":{"type":"object","properties":{"fieldName":{"type":"string","enum":["amount","targetAmount","networkFeeAmount","platformFeeAmount","transactionFeeAmount"],"nullable":true},"currencyCode":{"type":"string","nullable":true},"amount":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"transactionReview":{"type":"object","properties":{"riskLevel":{"type":"string","enum":["Low","Medium","High","No risk"],"nullable":true},"status":{"type":"string","enum":["pending","approved","under_investigation","blocked","failed"],"nullable":true}},"additionalProperties":false,"nullable":true},"originator":{"type":"object","properties":{"partyId":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["individual","company","smart-contract"],"nullable":true},"transactionMethod":{"type":"object","properties":{"type":{"type":"string","enum":["card","account","crypto"],"nullable":true},"accountId":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"institution":{"type":"object","properties":{"name":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"address":{"type":"object","properties":{"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true}},"additionalProperties":false,"nullable":true}},"additionalProperties":false,"nullable":true},"beneficiary":{"type":"object","properties":{"partyId":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["individual","company","smart-contract"],"nullable":true},"transactionMethod":{"type":"object","properties":{"type":{"type":"string","enum":["card","account","crypto"],"nullable":true},"accountId":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"institution":{"type":"object","properties":{"name":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"address":{"type":"object","properties":{"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true}},"additionalProperties":false,"nullable":true}},"additionalProperties":false,"nullable":true}},"additionalProperties":false},"nullable":true},"tagsToEntity":{"type":"array","items":{"type":"object","properties":{"id":{},"tagId":{"type":"string"},"entityId":{"type":"string"},"entityType":{"type":"string","enum":["transactionReview","customer","alert","wallet"]},"createdBy":{"type":"string","nullable":true},"tags":{"type":"object","properties":{"id":{},"type":{"type":"string","enum":["transaction","individual","company","wallet"]},"title":{"type":"string"},"backgroundColor":{"type":"string"},"textColor":{"type":"string"},"workspaceId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"deletedAt":{"type":"string","format":"date-time","nullable":true},"createdBy":{"type":"string","nullable":true},"updatedBy":{"type":"string","nullable":true}},"required":["id","type","title","backgroundColor","textColor","workspaceId"],"additionalProperties":false}},"required":["id","tagId","entityId","entityType","tags"],"additionalProperties":false},"nullable":true},"rulesMergeOperator":{"type":"string","enum":["AND","OR"],"nullable":true}},"required":["id","severity","category","type","status","name","description","assignedTo","seen","customerId","cmsProjectId","organizationId","workspaceId","createdAt","updatedAt","createdBy","updatedBy","reason"],"additionalProperties":false}}},"required":["id","name","type","status","severity","customerId","managersCount","createdAt","createdBy","subAlerts"],"additionalProperties":false}}},"required":["totalCount","data"],"additionalProperties":false},"example":{"totalCount":42,"data":[{"id":"example","name":"Jane Doe","description":"Example description","type":"DEFAULT","status":"Open","severity":"Low","customerId":"example","managersCount":42,"scenarioAlertCount":42,"workflowSessionId":"example","workflowId":"example","workflowName":"Jane Doe","workflowType":"DEFAULT","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","subAlerts":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","severity":"Low","category":"Onboarding","type":"AML Screening","status":"Open","name":"Jane Doe","description":"Example description","assignedTo":"example","seen":true,"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","reason":"Manual review required","workflowSessionId":"example","notes":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","name":"Jane Doe","description":"Example description","data":{},"cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","documents":[]}],"complyAdvantageData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","searchId":42,"searchRef":"example","searchResult":{"client_ref":"example","id":42,"ref":"example","searcher_id":42,"assignee_id":42,"filters":{"types":[],"birth_year":2024,"remove_deceased":1,"entity_type":"person","country_codes":[]},"match_status":"unknown","risk_level":"low","search_term":"example","submitted_term":"example","total_hits":42,"total_matches":42,"total_blacklist_hits":42,"created_at":"2024-05-14T09:30:00.000Z","updated_at":"2024-05-14T09:30:00.000Z","tags":[],"labels":[],"limit":42,"offset":42,"searcher":{"id":42,"email":"jane.doe@example.com","name":"Jane Doe","phone":"+4915112345678","created_at":"2024-05-14T09:30:00.000Z","user_is_active":true},"assignee":{"id":42,"email":"jane.doe@example.com","name":"Jane Doe","phone":"+4915112345678","created_at":"2024-05-14T09:30:00.000Z","user_is_active":true},"hits":[],"blacklist_hits":[]},"searchEntities":[],"requestData":{"search_term":"example","client_ref":"example","search_profile":"example","fuzziness":1,"offset":42,"limit":42,"filters":{"types":[],"birth_year":2024,"remove_deceased":1,"entity_type":"person","country_codes":[]},"tags":[],"share_url":1,"exact_match":true},"executionId":"example","alertId":"3b241101-e2bb-4255-8caf-4136c566a962","workflowSessionId":"example","isMonitored":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}],"duplicateData":[{"original":{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","customerInfo":"example","profilePictureUrl":"https://example.com/resource","idDocumentUrl":"https://example.com/resource"},"duplicate":{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","customerInfo":"example","profilePictureUrl":"https://example.com/resource","idDocumentUrl":"https://example.com/resource"}}],"cmsScenarioId":"example","scenarioName":"Jane Doe","results":[{"data":{"AMLScreeningsResults":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"ProofOfResidence":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"IDScanSelfie":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"IDImage":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"IDInformation":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"SelfieImage":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"RulesEngineInputData":{"exampleKey":{}},"TFHEResult":"example"},"ruleData":{"queryId":"query_3b241101e2bb42558caf4136","id":"query_3b241101e2bb42558caf4136","requestId":42,"attribute":{"version":"v1","schema":"Customer","path":"example"},"secondaryAttribute":{"version":"v1","schema":"Customer","path":"example"},"value":true,"operator":"$noop","displayMode":"amount","timeframe":"daily","datasetColumnId":"datasetc_3b241101e2bb42558caf4136","sourceDatasetColumnId":"datasetc_3b241101e2bb42558caf4136","specialDataSetType":"ACTIVE_USERS_ADDRESSES"},"status":"valid","cmsScenarioId":"example","scenarioName":"Jane Doe","queryBlocksMergeOperator":"AND","queryGroupId":"example","queryGroupOperator":"AND","queryGroupIndex":42}],"transactions":[{"id":"tx_3b241101e2bb42558caf4136","transactionDate":"2024-05-14T09:30:00.000Z","transactionType":"crypto","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","transactionInfo":{"hash":"example","blockchainChainId":"example","direction":"IN","amount":"example","currencyCode":"example","hashUrl":"https://example.com/resource"},"transactionAmounts":[],"transactionReview":{"riskLevel":"Low","status":"pending"},"originator":{"partyId":"example","name":"Jane Doe","type":"individual","transactionMethod":{"type":"card","accountId":"example"},"institution":{"name":"Jane Doe"},"address":{"country":"AFG"}},"beneficiary":{"partyId":"example","name":"Jane Doe","type":"individual","transactionMethod":{"type":"card","accountId":"example"},"institution":{"name":"Jane Doe"},"address":{"country":"AFG"}}}],"tagsToEntity":[{"id":"tte_3b241101e2bb42558caf4136","tagId":"example","entityId":"example","entityType":"transactionReview","createdBy":"workspace","tags":{"id":"tag_3b241101e2bb42558caf4136","type":"transaction","title":"Example title","backgroundColor":"example","textColor":"example","workspaceId":"example","organizationId":"example","deletedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}],"rulesMergeOperator":"AND"}]}]}}}},"default":{"$ref":"#/components/responses/error"}}}},"/customers/{customerId}/alerts":{"get":{"operationId":"alertsRouter-getAlertsForCustomer","summary":"Get alerts for customer","description":"Get all alerts for a customer.","tags":["Alerts"],"security":[{"Authorization":[]}],"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"workflowSessionId","in":"query","required":false,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"},{"name":"alertType","in":"query","required":false,"schema":{"type":"string","enum":["AML Screening","IP Screening","Email Screening","KYC Drop-off","Onchain Monitoring","Fraud","Transaction Monitoring","Duplicate","Individual Monitoring","Compliance Review Required"]},"example":"AML Screening"},{"name":"alertStatus","in":"query","required":false,"schema":{"type":"string","enum":["Open","Under Investigation","Pending","Closed","Escalated"]},"example":"Open"},{"name":"category","in":"query","required":false,"schema":{"type":"string","enum":["Onboarding","Ongoing monitoring"]},"example":"Onboarding"},{"name":"alertIds","in":"query","required":false,"schema":{"type":"string"},"example":"example"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"type":{"type":"string"},"status":{"type":"string","enum":["Open","Under Investigation","Pending","Closed","Escalated"]},"severity":{"type":"string","enum":["Low","Medium","High"]},"customerId":{"type":"string"},"managersCount":{"type":"number"},"scenarioAlertCount":{"type":"number","nullable":true},"workflowSessionId":{"type":"string","nullable":true},"workflowId":{"type":"string","nullable":true},"workflowName":{"type":"string","nullable":true},"workflowType":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"subAlerts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"severity":{"type":"string","enum":["Low","Medium","High"]},"category":{"type":"string","enum":["Onboarding","Ongoing monitoring"]},"type":{"type":"string","enum":["AML Screening","IP Screening","Email Screening","KYC Drop-off","Onchain Monitoring","Fraud","Transaction Monitoring","Duplicate","Individual Monitoring","Compliance Review Required"]},"status":{"type":"string","enum":["Open","Under Investigation","Pending","Closed","Escalated"]},"name":{"type":"string"},"description":{"type":"string","nullable":true},"assignedTo":{"type":"string","nullable":true},"seen":{"type":"boolean"},"customerId":{"type":"string","format":"uuid"},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"reason":{"type":"string","nullable":true},"workflowSessionId":{"type":"string","nullable":true},"notes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"data":{},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"objectKey":{"type":"string","format":"uuid"},"filename":{"type":"string"},"mimetype":{"type":"string"},"description":{"type":"string","nullable":true},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"presignedUrl":{"type":"string"}},"required":["id","objectKey","filename","mimetype","description","cmsProjectId","organizationId","workspaceId","createdAt","createdBy","presignedUrl"],"additionalProperties":false}}},"required":["id","name","description","cmsProjectId","organizationId","workspaceId","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"complyAdvantageData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid","nullable":true},"searchId":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"nullable":true},"searchRef":{"type":"string","nullable":true},"searchResult":{"type":"object","properties":{"client_ref":{"type":"string"},"id":{"type":"number"},"ref":{"type":"string"},"searcher_id":{"type":"number"},"assignee_id":{"type":"number"},"filters":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]},"nullable":true},"birth_year":{"type":"number","nullable":true},"remove_deceased":{"type":"number","minimum":0,"maximum":1,"nullable":true},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"],"nullable":true},"country_codes":{"type":"array","items":{"type":"string","enum":["AN","XK","AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"nullable":true}},"additionalProperties":false},"match_status":{"type":"string","enum":["unknown","no_match","potential_match","false_positive","true_positive","true_positive_approve","true_positive_reject"]},"risk_level":{"type":"string","enum":["low","medium","high","unknown"]},"search_term":{"type":"string"},"submitted_term":{"type":"string"},"total_hits":{"type":"number"},"total_matches":{"type":"number"},"total_blacklist_hits":{"type":"number"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"tags":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"labels":{"type":"array","items":{}},"limit":{"type":"number"},"offset":{"type":"number"},"searcher":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string","format":"email"},"name":{"type":"string"},"phone":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"user_is_active":{"type":"boolean"}},"required":["id","email","name","phone","created_at","user_is_active"],"additionalProperties":false},"assignee":{"type":"object","properties":{"id":{"type":"number"},"email":{"type":"string","format":"email"},"name":{"type":"string"},"phone":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"user_is_active":{"type":"boolean"}},"required":["id","email","name","phone","created_at","user_is_active"],"additionalProperties":false},"hits":{"type":"array","items":{"type":"object","properties":{"doc":{"type":"object","properties":{"id":{"type":"string"},"last_updated_utc":{"type":"string","format":"date-time"},"created_utc":{"type":"string","format":"date-time"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"source":{"type":"string"},"value":{"type":"string"},"locale":{"type":"string"},"tag":{"type":"string"}},"required":["name","value"],"additionalProperties":false}},"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]}},"name":{"type":"string"},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"]},"aka":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false}},"associates":{"type":"array","items":{"type":"object","properties":{"association":{"type":"string"},"name":{"type":"string"}},"required":["association","name"],"additionalProperties":false}},"sources":{"type":"array","items":{"type":"string"}},"keywords":{"type":"array","items":{}},"media":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"snippet":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["snippet","title","url"],"additionalProperties":false}},"source_notes":{}},"required":["id","last_updated_utc","created_utc","types","name","entity_type","aka","sources","keywords"],"additionalProperties":false},"match_types":{"type":"array","items":{"type":"string"}},"match_types_details":{"type":"array","items":{"type":"object","properties":{"aml_types":{"type":"array","items":{"type":"string"}},"matching_name":{"type":"string"},"name_matches":{"type":"array","items":{"type":"object","properties":{"match_types":{"type":"array","items":{"type":"string"}},"query_term":{"type":"string"}},"required":["match_types","query_term"],"additionalProperties":false}},"secondary_matches":{"type":"array","items":{}},"sources":{"type":"array","items":{"type":"string"}}},"required":["aml_types","matching_name","name_matches","secondary_matches","sources"],"additionalProperties":false}},"match_status":{"type":"string"},"is_whitelisted":{"type":"boolean"},"score":{"type":"number"}},"required":["doc","match_types","match_types_details","match_status","is_whitelisted","score"],"additionalProperties":false}},"blacklist_hits":{"type":"array","items":{}}},"required":["client_ref","id","ref","searcher_id","assignee_id","match_status","risk_level","search_term","submitted_term","total_hits","total_matches","total_blacklist_hits","created_at","updated_at","labels","limit","offset"],"additionalProperties":false},"searchEntities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"last_updated_utc":{"type":"string","format":"date-time"},"created_utc":{"type":"string","format":"date-time"},"key_information":{"type":"object","properties":{"name":{"type":"string"},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"]},"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]},"nullable":true},"grouped_types":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]}},"required":["type"],"additionalProperties":false},"nullable":true},"match_types":{"type":"array","items":{"type":"string"},"nullable":true},"sources":{"type":"array","items":{"type":"string"},"nullable":true},"source_notes":{"nullable":true},"aka":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false},"nullable":true},"date_of_birth":{"type":"string","nullable":true},"dates_of_birth":{"type":"array","items":{"type":"string"},"nullable":true},"match_status":{"type":"string","enum":["unknown","no_match","potential_match","false_positive","true_positive","true_positive_approve","true_positive_reject"],"nullable":true},"risk_level":{"type":"string","enum":["low","medium","high","unknown"],"nullable":true},"is_whitelisted":{"type":"boolean","nullable":true},"age":{"type":"number","nullable":true},"death_age":{"nullable":true},"date_of_death":{"nullable":true},"primary_country":{"nullable":true},"country_names":{"type":"string","nullable":true},"designation":{"type":"string","nullable":true},"associates":{"type":"array","items":{"type":"object","properties":{"association":{"type":"string"},"name":{"type":"string"}},"required":["association","name"],"additionalProperties":false},"nullable":true}},"required":["name","entity_type"],"additionalProperties":false,"nullable":true},"uncategorized":{"type":"object","properties":{"keywords":{"type":"array","items":{},"nullable":true},"media":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"snippet":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["snippet","title","url"],"additionalProperties":false},"nullable":true},"assets":{"type":"array","items":{},"nullable":true},"match_types":{"type":"array","items":{"type":"string"},"nullable":true},"related":{"type":"array","items":{},"nullable":true},"fields":{"type":"array","items":{},"nullable":true}},"additionalProperties":false,"nullable":true},"full_listing":{"type":"object","additionalProperties":{"anyOf":[{"not":{}},{"type":"object","additionalProperties":{"anyOf":[{"not":{}},{"type":"object","properties":{"aml_types":{"type":"array","items":{"type":"string"},"nullable":true},"count":{"type":"number","nullable":true},"country_codes":{"type":"array","items":{"type":"string"},"nullable":true},"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"disclose_sources":{"type":"boolean","nullable":true},"listing_ended_utc":{"type":"string","nullable":true},"listing_started_utc":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"url":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true}]},"nullable":true}]},"nullable":true},"navigation":{"type":"object","properties":{"next":{"nullable":true},"previous":{"nullable":true}},"additionalProperties":false,"nullable":true}},"required":["id","last_updated_utc","created_utc"],"additionalProperties":false},"nullable":true},"requestData":{"type":"object","properties":{"search_term":{"type":"string","description":"represents name of the entity"},"client_ref":{"type":"string","description":"Your reference for this person/entity for which you are searching. Used for tracking searches and auto-whitelisting recurring results"},"search_profile":{"type":"string","nullable":true,"description":"The Profile ID of a search profile that can be retrieved from the UI"},"fuzziness":{"type":"number","minimum":0,"maximum":1,"nullable":true,"description":"determines how closely the returned results must match the supplied name. Overridden by exact_match"},"offset":{"type":"number","nullable":true,"description":"match results from the database, starting form the offset value"},"limit":{"type":"number","nullable":true,"description":"math results from the database, taking up this many matches each search"},"filters":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["sanction","warning","fitness-probity","pep","pep-class-1","pep-class-2","pep-class-3","pep-class-4","adverse-media","adverse-media-financial-crime","adverse-media-violent-crime","adverse-media-sexual-crime","adverse-media-terrorism","adverse-media-fraud","adverse-media-narcotics","adverse-media-general","adverse-media-v2-property","adverse-media-v2-financial-aml-cft","adverse-media-v2-fraud-linked","adverse-media-v2-narcotics-aml-cft","adverse-media-v2-violence-aml-cft","adverse-media-v2-terrorism","adverse-media-v2-cybercrime","adverse-media-v2-general-aml-cft","adverse-media-v2-regulatory","adverse-media-v2-financial-difficulty","adverse-media-v2-violence-non-aml-cft","adverse-media-v2-other-financial","adverse-media-v2-other-serious","adverse-media-v2-other-minor"]},"nullable":true},"birth_year":{"type":"number","nullable":true},"remove_deceased":{"type":"number","minimum":0,"maximum":1,"nullable":true},"entity_type":{"type":"string","enum":["person","company","organisation","vessel","aircraft"],"nullable":true},"country_codes":{"type":"array","items":{"type":"string","enum":["AN","XK","AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"nullable":true}},"additionalProperties":false,"description":"specify filters within the search to narrow down the results"},"tags":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}},"nullable":true,"description":"name => value pairs, to search later using defined tags here"},"share_url":{"type":"number","minimum":0,"maximum":1,"nullable":true,"description":"include a shareable URL to access search publicly"},"exact_match":{"type":"boolean","nullable":true,"description":"Exact match disables all standard and optional matching behaviours (Honorifics, affixes, initials, glued name, name variation, equivalent names, extra words in entity,...) 0% fuzziness disables 1 letter typo matching but keeps all other matching behaviours (standard and optional)"}},"required":["search_term","client_ref"],"additionalProperties":false},"executionId":{"type":"string"},"alertId":{"type":"string","format":"uuid","nullable":true},"workflowSessionId":{"type":"string","nullable":true},"isMonitored":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","customerId","searchId","searchRef","searchResult","requestData","executionId","alertId","isMonitored","createdAt","updatedAt"],"additionalProperties":false},"nullable":true},"duplicateData":{"type":"array","items":{"type":"object","properties":{"original":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"customerInfo":{"type":"string","nullable":true},"profilePictureUrl":{"type":"string","nullable":true},"idDocumentUrl":{"type":"string","nullable":true}},"required":["customerId"],"additionalProperties":false},"duplicate":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"customerInfo":{"type":"string","nullable":true},"profilePictureUrl":{"type":"string","nullable":true},"idDocumentUrl":{"type":"string","nullable":true}},"required":["customerId"],"additionalProperties":false}},"required":["original","duplicate"],"additionalProperties":false},"nullable":true},"cmsScenarioId":{"type":"string","nullable":true},"scenarioName":{"type":"string","nullable":true},"results":{"type":"array","items":{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"AMLScreeningsResults":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"ProofOfResidence":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDScanSelfie":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDImage":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDInformation":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"SelfieImage":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"RulesEngineInputData":{"type":"object","additionalProperties":{},"nullable":true},"TFHEResult":{"type":"string","nullable":true}},"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"typ":{"type":"string","enum":["application/iden3-zkp-json","application/iden3comm-plain-json","application/iden3comm-signed-json"]},"type":{"type":"string","enum":["https://iden3-communication.io/authorization/1.0/request","https://iden3-communication.io/authorization/1.0/response","https://iden3-communication.io/credentials/1.0/issuance-request","https://iden3-communication.io/credentials/1.0/fetch-request","https://iden3-communication.io/credentials/1.0/offer","https://iden3-communication.io/credentials/1.0/issuance-response","https://iden3-communication.io/credentials/1.0/refresh","https://iden3-communication.io/devices/1.0/registration","https://iden3-communication.io/messages/1.0/fetch","https://iden3-communication.io/proofs/1.0/request","https://iden3-communication.io/proofs/1.0/response","https://iden3-communication.io/revocation/1.0/request-status","https://iden3-communication.io/revocation/1.0/status","https://iden3-communication.io/proofs/1.0/contract-invoke-request","https://iden3-communication.io/proofs/1.0/contract-invoke-response","https://iden3-communication.io/credentials/1.0/onchain-offer","https://iden3-communication.io/credentials/0.1/proposal-request","https://iden3-communication.io/credentials/0.1/proposal","https://iden3-communication.io/credentials/0.1/payment-request","https://iden3-communication.io/credentials/0.1/payment"]},"thid":{"type":"string"},"body":{"type":"object","properties":{"callbackUrl":{"type":"string"},"reason":{"type":"string"},"did_doc":{},"message":{"type":"string"},"scope":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"number"},{"type":"string"}]},"circuitId":{"type":"string"},"optional":{"type":"boolean"},"query":{"type":"object","additionalProperties":{}}},"required":["id","circuitId","query"],"additionalProperties":false}}},"required":["callbackUrl","scope"],"additionalProperties":false},"from":{"type":"string"},"to":{"type":"string"}},"required":["id","type","body","from"],"additionalProperties":false}],"nullable":true},"ruleData":{"type":"object","properties":{"queryId":{"description":"Unique ID for the query"},"id":{"description":"Unique ID for the query"},"requestId":{"type":"number","nullable":true,"description":"Request ID for ZKPs"},"attribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"],"additionalProperties":false},"secondaryAttribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"],"additionalProperties":false,"nullable":true},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"number"}}],"nullable":true},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"displayMode":{"type":"string","enum":["amount","percentage"],"nullable":true},"timeframe":{"type":"string","enum":["daily","weekly","monthly","yearly"],"nullable":true},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","enum":["ACTIVE_USERS_ADDRESSES"],"nullable":true}},"required":["attribute","operator"],"additionalProperties":false,"nullable":true},"status":{"type":"string","enum":["valid","not-valid","skipped","error","unknown"],"nullable":true},"cmsScenarioId":{"type":"string","nullable":true},"scenarioName":{"type":"string","nullable":true},"queryBlocksMergeOperator":{"type":"string","enum":["AND","OR"],"nullable":true},"queryGroupId":{"type":"string","nullable":true},"queryGroupOperator":{"type":"string","enum":["AND","OR"],"nullable":true},"queryGroupIndex":{"type":"number","nullable":true}},"additionalProperties":false},"nullable":true},"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"nullable":true},"transactionDate":{"type":"string","format":"date-time","nullable":true},"transactionType":{"type":"string","enum":["crypto","fiat"],"nullable":true},"customerId":{"type":"string","format":"uuid","nullable":true},"transactionInfo":{"type":"object","properties":{"hash":{"type":"string","nullable":true},"blockchainChainId":{"type":"string","nullable":true},"direction":{"type":"string","enum":["IN","OUT","EXCHANGE"],"nullable":true},"amount":{"type":"string","nullable":true},"currencyCode":{"type":"string","nullable":true},"hashUrl":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"transactionAmounts":{"type":"array","items":{"type":"object","properties":{"fieldName":{"type":"string","enum":["amount","targetAmount","networkFeeAmount","platformFeeAmount","transactionFeeAmount"],"nullable":true},"currencyCode":{"type":"string","nullable":true},"amount":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"transactionReview":{"type":"object","properties":{"riskLevel":{"type":"string","enum":["Low","Medium","High","No risk"],"nullable":true},"status":{"type":"string","enum":["pending","approved","under_investigation","blocked","failed"],"nullable":true}},"additionalProperties":false,"nullable":true},"originator":{"type":"object","properties":{"partyId":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["individual","company","smart-contract"],"nullable":true},"transactionMethod":{"type":"object","properties":{"type":{"type":"string","enum":["card","account","crypto"],"nullable":true},"accountId":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"institution":{"type":"object","properties":{"name":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"address":{"type":"object","properties":{"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true}},"additionalProperties":false,"nullable":true}},"additionalProperties":false,"nullable":true},"beneficiary":{"type":"object","properties":{"partyId":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["individual","company","smart-contract"],"nullable":true},"transactionMethod":{"type":"object","properties":{"type":{"type":"string","enum":["card","account","crypto"],"nullable":true},"accountId":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"institution":{"type":"object","properties":{"name":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"address":{"type":"object","properties":{"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true}},"additionalProperties":false,"nullable":true}},"additionalProperties":false,"nullable":true}},"additionalProperties":false},"nullable":true},"tagsToEntity":{"type":"array","items":{"type":"object","properties":{"id":{},"tagId":{"type":"string"},"entityId":{"type":"string"},"entityType":{"type":"string","enum":["transactionReview","customer","alert","wallet"]},"createdBy":{"type":"string","nullable":true},"tags":{"type":"object","properties":{"id":{},"type":{"type":"string","enum":["transaction","individual","company","wallet"]},"title":{"type":"string"},"backgroundColor":{"type":"string"},"textColor":{"type":"string"},"workspaceId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"deletedAt":{"type":"string","format":"date-time","nullable":true},"createdBy":{"type":"string","nullable":true},"updatedBy":{"type":"string","nullable":true}},"required":["id","type","title","backgroundColor","textColor","workspaceId"],"additionalProperties":false}},"required":["id","tagId","entityId","entityType","tags"],"additionalProperties":false},"nullable":true},"rulesMergeOperator":{"type":"string","enum":["AND","OR"],"nullable":true}},"required":["id","severity","category","type","status","name","description","assignedTo","seen","customerId","cmsProjectId","organizationId","workspaceId","createdAt","updatedAt","createdBy","updatedBy","reason"],"additionalProperties":false}}},"required":["id","name","type","status","severity","customerId","managersCount","createdAt","createdBy","subAlerts"],"additionalProperties":false}},"example":[{"id":"example","name":"Jane Doe","description":"Example description","type":"DEFAULT","status":"Open","severity":"Low","customerId":"example","managersCount":42,"scenarioAlertCount":42,"workflowSessionId":"example","workflowId":"example","workflowName":"Jane Doe","workflowType":"DEFAULT","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","subAlerts":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","severity":"Low","category":"Onboarding","type":"AML Screening","status":"Open","name":"Jane Doe","description":"Example description","assignedTo":"example","seen":true,"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","reason":"Manual review required","workflowSessionId":"example","notes":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","name":"Jane Doe","description":"Example description","data":{},"cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","documents":[]}],"complyAdvantageData":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","searchId":42,"searchRef":"example","searchResult":{"client_ref":"example","id":42,"ref":"example","searcher_id":42,"assignee_id":42,"filters":{"types":[],"birth_year":2024,"remove_deceased":1,"entity_type":"person","country_codes":[]},"match_status":"unknown","risk_level":"low","search_term":"example","submitted_term":"example","total_hits":42,"total_matches":42,"total_blacklist_hits":42,"created_at":"2024-05-14T09:30:00.000Z","updated_at":"2024-05-14T09:30:00.000Z","tags":[],"labels":[],"limit":42,"offset":42,"searcher":{"id":42,"email":"jane.doe@example.com","name":"Jane Doe","phone":"+4915112345678","created_at":"2024-05-14T09:30:00.000Z","user_is_active":true},"assignee":{"id":42,"email":"jane.doe@example.com","name":"Jane Doe","phone":"+4915112345678","created_at":"2024-05-14T09:30:00.000Z","user_is_active":true},"hits":[],"blacklist_hits":[]},"searchEntities":[],"requestData":{"search_term":"example","client_ref":"example","search_profile":"example","fuzziness":1,"offset":42,"limit":42,"filters":{"types":[],"birth_year":2024,"remove_deceased":1,"entity_type":"person","country_codes":[]},"tags":[],"share_url":1,"exact_match":true},"executionId":"example","alertId":"3b241101-e2bb-4255-8caf-4136c566a962","workflowSessionId":"example","isMonitored":true,"createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z"}],"duplicateData":[{"original":{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","customerInfo":"example","profilePictureUrl":"https://example.com/resource","idDocumentUrl":"https://example.com/resource"},"duplicate":{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","customerInfo":"example","profilePictureUrl":"https://example.com/resource","idDocumentUrl":"https://example.com/resource"}}],"cmsScenarioId":"example","scenarioName":"Jane Doe","results":[{"data":{"AMLScreeningsResults":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"ProofOfResidence":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"IDScanSelfie":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"IDImage":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"IDInformation":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"SelfieImage":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"RulesEngineInputData":{"exampleKey":{}},"TFHEResult":"example"},"ruleData":{"queryId":"query_3b241101e2bb42558caf4136","id":"query_3b241101e2bb42558caf4136","requestId":42,"attribute":{"version":"v1","schema":"Customer","path":"example"},"secondaryAttribute":{"version":"v1","schema":"Customer","path":"example"},"value":true,"operator":"$noop","displayMode":"amount","timeframe":"daily","datasetColumnId":"datasetc_3b241101e2bb42558caf4136","sourceDatasetColumnId":"datasetc_3b241101e2bb42558caf4136","specialDataSetType":"ACTIVE_USERS_ADDRESSES"},"status":"valid","cmsScenarioId":"example","scenarioName":"Jane Doe","queryBlocksMergeOperator":"AND","queryGroupId":"example","queryGroupOperator":"AND","queryGroupIndex":42}],"transactions":[{"id":"tx_3b241101e2bb42558caf4136","transactionDate":"2024-05-14T09:30:00.000Z","transactionType":"crypto","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","transactionInfo":{"hash":"example","blockchainChainId":"example","direction":"IN","amount":"example","currencyCode":"example","hashUrl":"https://example.com/resource"},"transactionAmounts":[],"transactionReview":{"riskLevel":"Low","status":"pending"},"originator":{"partyId":"example","name":"Jane Doe","type":"individual","transactionMethod":{"type":"card","accountId":"example"},"institution":{"name":"Jane Doe"},"address":{"country":"AFG"}},"beneficiary":{"partyId":"example","name":"Jane Doe","type":"individual","transactionMethod":{"type":"card","accountId":"example"},"institution":{"name":"Jane Doe"},"address":{"country":"AFG"}}}],"tagsToEntity":[{"id":"tte_3b241101e2bb42558caf4136","tagId":"example","entityId":"example","entityType":"transactionReview","createdBy":"workspace","tags":{"id":"tag_3b241101e2bb42558caf4136","type":"transaction","title":"Example title","backgroundColor":"example","textColor":"example","workspaceId":"example","organizationId":"example","deletedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}],"rulesMergeOperator":"AND"}]}]}}},"default":{"$ref":"#/components/responses/error"}}}},"/transactions/{id}/alerts":{"get":{"operationId":"alertsRouter-getAlertsForTransaction","summary":"Get alerts for transaction","description":"Get all alerts for a transaction.","tags":["Alerts"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"transaction id","example":"example"},{"name":"alertType","in":"query","required":false,"schema":{"type":"string","enum":["AML Screening","IP Screening","Email Screening","KYC Drop-off","Onchain Monitoring","Fraud","Transaction Monitoring","Duplicate","Individual Monitoring","Compliance Review Required"]},"example":"AML Screening"},{"name":"alertStatus","in":"query","required":false,"schema":{"type":"string","enum":["Open","Under Investigation","Pending","Closed","Escalated"]},"example":"Open"},{"name":"category","in":"query","required":false,"schema":{"type":"string","enum":["Onboarding","Ongoing monitoring"]},"example":"Onboarding"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"type":{"type":"string"},"status":{"type":"string","enum":["Open","Under Investigation","Pending","Closed","Escalated"]},"severity":{"type":"string","enum":["Low","Medium","High"]},"customerId":{"type":"string"},"managersCount":{"type":"number"},"scenarioAlertCount":{"type":"number","nullable":true},"workflowSessionId":{"type":"string","nullable":true},"workflowId":{"type":"string","nullable":true},"workflowName":{"type":"string","nullable":true},"workflowType":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"subAlerts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"severity":{"type":"string","enum":["Low","Medium","High"]},"category":{"type":"string","enum":["Onboarding","Ongoing monitoring"]},"type":{"type":"string","enum":["AML Screening","IP Screening","Email Screening","KYC Drop-off","Onchain Monitoring","Fraud","Transaction Monitoring","Duplicate","Individual Monitoring","Compliance Review Required"]},"status":{"type":"string","enum":["Open","Under Investigation","Pending","Closed","Escalated"]},"name":{"type":"string"},"description":{"type":"string","nullable":true},"assignedTo":{"type":"string","nullable":true},"seen":{"type":"boolean"},"customerId":{"type":"string","format":"uuid"},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"reason":{"type":"string","nullable":true},"workflowSessionId":{"type":"string","nullable":true},"notes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"data":{},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"objectKey":{"type":"string","format":"uuid"},"filename":{"type":"string"},"mimetype":{"type":"string"},"description":{"type":"string","nullable":true},"cmsProjectId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"presignedUrl":{"type":"string"}},"required":["id","objectKey","filename","mimetype","description","cmsProjectId","organizationId","workspaceId","createdAt","createdBy","presignedUrl"],"additionalProperties":false}}},"required":["id","name","description","cmsProjectId","organizationId","workspaceId","createdAt","updatedAt","createdBy","updatedBy"],"additionalProperties":false}},"duplicateData":{"type":"array","items":{"type":"object","properties":{"original":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"customerInfo":{"type":"string","nullable":true},"profilePictureUrl":{"type":"string","nullable":true},"idDocumentUrl":{"type":"string","nullable":true}},"required":["customerId"],"additionalProperties":false},"duplicate":{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"customerInfo":{"type":"string","nullable":true},"profilePictureUrl":{"type":"string","nullable":true},"idDocumentUrl":{"type":"string","nullable":true}},"required":["customerId"],"additionalProperties":false}},"required":["original","duplicate"],"additionalProperties":false},"nullable":true},"cmsScenarioId":{"type":"string","nullable":true},"scenarioName":{"type":"string","nullable":true},"results":{"type":"array","items":{"type":"object","properties":{"data":{"anyOf":[{"type":"object","properties":{"AMLScreeningsResults":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"ProofOfResidence":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDScanSelfie":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDImage":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"IDInformation":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"SelfieImage":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false,"nullable":true},"RulesEngineInputData":{"type":"object","additionalProperties":{},"nullable":true},"TFHEResult":{"type":"string","nullable":true}},"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"typ":{"type":"string","enum":["application/iden3-zkp-json","application/iden3comm-plain-json","application/iden3comm-signed-json"]},"type":{"type":"string","enum":["https://iden3-communication.io/authorization/1.0/request","https://iden3-communication.io/authorization/1.0/response","https://iden3-communication.io/credentials/1.0/issuance-request","https://iden3-communication.io/credentials/1.0/fetch-request","https://iden3-communication.io/credentials/1.0/offer","https://iden3-communication.io/credentials/1.0/issuance-response","https://iden3-communication.io/credentials/1.0/refresh","https://iden3-communication.io/devices/1.0/registration","https://iden3-communication.io/messages/1.0/fetch","https://iden3-communication.io/proofs/1.0/request","https://iden3-communication.io/proofs/1.0/response","https://iden3-communication.io/revocation/1.0/request-status","https://iden3-communication.io/revocation/1.0/status","https://iden3-communication.io/proofs/1.0/contract-invoke-request","https://iden3-communication.io/proofs/1.0/contract-invoke-response","https://iden3-communication.io/credentials/1.0/onchain-offer","https://iden3-communication.io/credentials/0.1/proposal-request","https://iden3-communication.io/credentials/0.1/proposal","https://iden3-communication.io/credentials/0.1/payment-request","https://iden3-communication.io/credentials/0.1/payment"]},"thid":{"type":"string"},"body":{"type":"object","properties":{"callbackUrl":{"type":"string"},"reason":{"type":"string"},"did_doc":{},"message":{"type":"string"},"scope":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"number"},{"type":"string"}]},"circuitId":{"type":"string"},"optional":{"type":"boolean"},"query":{"type":"object","additionalProperties":{}}},"required":["id","circuitId","query"],"additionalProperties":false}}},"required":["callbackUrl","scope"],"additionalProperties":false},"from":{"type":"string"},"to":{"type":"string"}},"required":["id","type","body","from"],"additionalProperties":false}],"nullable":true},"ruleData":{"type":"object","properties":{"queryId":{"description":"Unique ID for the query"},"id":{"description":"Unique ID for the query"},"requestId":{"type":"number","nullable":true,"description":"Request ID for ZKPs"},"attribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"],"additionalProperties":false},"secondaryAttribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"],"additionalProperties":false,"nullable":true},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"number"}}],"nullable":true},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"displayMode":{"type":"string","enum":["amount","percentage"],"nullable":true},"timeframe":{"type":"string","enum":["daily","weekly","monthly","yearly"],"nullable":true},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","enum":["ACTIVE_USERS_ADDRESSES"],"nullable":true}},"required":["attribute","operator"],"additionalProperties":false,"nullable":true},"status":{"type":"string","enum":["valid","not-valid","skipped","error","unknown"],"nullable":true},"cmsScenarioId":{"type":"string","nullable":true},"scenarioName":{"type":"string","nullable":true},"queryBlocksMergeOperator":{"type":"string","enum":["AND","OR"],"nullable":true},"queryGroupId":{"type":"string","nullable":true},"queryGroupOperator":{"type":"string","enum":["AND","OR"],"nullable":true},"queryGroupIndex":{"type":"number","nullable":true}},"additionalProperties":false},"nullable":true},"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"nullable":true},"transactionDate":{"type":"string","format":"date-time","nullable":true},"transactionType":{"type":"string","enum":["crypto","fiat"],"nullable":true},"customerId":{"type":"string","format":"uuid","nullable":true},"transactionInfo":{"type":"object","properties":{"hash":{"type":"string","nullable":true},"blockchainChainId":{"type":"string","nullable":true},"direction":{"type":"string","enum":["IN","OUT","EXCHANGE"],"nullable":true},"amount":{"type":"string","nullable":true},"currencyCode":{"type":"string","nullable":true},"hashUrl":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"transactionAmounts":{"type":"array","items":{"type":"object","properties":{"fieldName":{"type":"string","enum":["amount","targetAmount","networkFeeAmount","platformFeeAmount","transactionFeeAmount"],"nullable":true},"currencyCode":{"type":"string","nullable":true},"amount":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"transactionReview":{"type":"object","properties":{"riskLevel":{"type":"string","enum":["Low","Medium","High","No risk"],"nullable":true},"status":{"type":"string","enum":["pending","approved","under_investigation","blocked","failed"],"nullable":true}},"additionalProperties":false,"nullable":true},"originator":{"type":"object","properties":{"partyId":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["individual","company","smart-contract"],"nullable":true},"transactionMethod":{"type":"object","properties":{"type":{"type":"string","enum":["card","account","crypto"],"nullable":true},"accountId":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"institution":{"type":"object","properties":{"name":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"address":{"type":"object","properties":{"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true}},"additionalProperties":false,"nullable":true}},"additionalProperties":false,"nullable":true},"beneficiary":{"type":"object","properties":{"partyId":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"type":{"type":"string","enum":["individual","company","smart-contract"],"nullable":true},"transactionMethod":{"type":"object","properties":{"type":{"type":"string","enum":["card","account","crypto"],"nullable":true},"accountId":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"institution":{"type":"object","properties":{"name":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"address":{"type":"object","properties":{"country":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true}},"additionalProperties":false,"nullable":true}},"additionalProperties":false,"nullable":true}},"additionalProperties":false},"nullable":true},"tagsToEntity":{"type":"array","items":{"type":"object","properties":{"id":{},"tagId":{"type":"string"},"entityId":{"type":"string"},"entityType":{"type":"string","enum":["transactionReview","customer","alert","wallet"]},"createdBy":{"type":"string","nullable":true},"tags":{"type":"object","properties":{"id":{},"type":{"type":"string","enum":["transaction","individual","company","wallet"]},"title":{"type":"string"},"backgroundColor":{"type":"string"},"textColor":{"type":"string"},"workspaceId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"deletedAt":{"type":"string","format":"date-time","nullable":true},"createdBy":{"type":"string","nullable":true},"updatedBy":{"type":"string","nullable":true}},"required":["id","type","title","backgroundColor","textColor","workspaceId"],"additionalProperties":false}},"required":["id","tagId","entityId","entityType","tags"],"additionalProperties":false},"nullable":true},"rulesMergeOperator":{"type":"string","enum":["AND","OR"],"nullable":true}},"required":["id","severity","category","type","status","name","description","assignedTo","seen","customerId","cmsProjectId","organizationId","workspaceId","createdAt","updatedAt","createdBy","updatedBy","reason"],"additionalProperties":false}}},"required":["id","name","type","status","severity","customerId","managersCount","createdAt","createdBy","subAlerts"],"additionalProperties":false}},"example":[{"id":"example","name":"Jane Doe","description":"Example description","type":"DEFAULT","status":"Open","severity":"Low","customerId":"example","managersCount":42,"scenarioAlertCount":42,"workflowSessionId":"example","workflowId":"example","workflowName":"Jane Doe","workflowType":"DEFAULT","createdAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","subAlerts":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","severity":"Low","category":"Onboarding","type":"AML Screening","status":"Open","name":"Jane Doe","description":"Example description","assignedTo":"example","seen":true,"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","reason":"Manual review required","workflowSessionId":"example","notes":[{"id":"3b241101-e2bb-4255-8caf-4136c566a962","name":"Jane Doe","description":"Example description","data":{},"cmsProjectId":"example","organizationId":"example","workspaceId":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","documents":[]}],"duplicateData":[{"original":{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","customerInfo":"example","profilePictureUrl":"https://example.com/resource","idDocumentUrl":"https://example.com/resource"},"duplicate":{"customerId":"3b241101-e2bb-4255-8caf-4136c566a962","customerInfo":"example","profilePictureUrl":"https://example.com/resource","idDocumentUrl":"https://example.com/resource"}}],"cmsScenarioId":"example","scenarioName":"Jane Doe","results":[{"data":{"AMLScreeningsResults":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"ProofOfResidence":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"IDScanSelfie":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"IDImage":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"IDInformation":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"SelfieImage":{"id":"example","@context":[],"type":[],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}},"RulesEngineInputData":{"exampleKey":{}},"TFHEResult":"example"},"ruleData":{"queryId":"query_3b241101e2bb42558caf4136","id":"query_3b241101e2bb42558caf4136","requestId":42,"attribute":{"version":"v1","schema":"Customer","path":"example"},"secondaryAttribute":{"version":"v1","schema":"Customer","path":"example"},"value":true,"operator":"$noop","displayMode":"amount","timeframe":"daily","datasetColumnId":"datasetc_3b241101e2bb42558caf4136","sourceDatasetColumnId":"datasetc_3b241101e2bb42558caf4136","specialDataSetType":"ACTIVE_USERS_ADDRESSES"},"status":"valid","cmsScenarioId":"example","scenarioName":"Jane Doe","queryBlocksMergeOperator":"AND","queryGroupId":"example","queryGroupOperator":"AND","queryGroupIndex":42}],"transactions":[{"id":"tx_3b241101e2bb42558caf4136","transactionDate":"2024-05-14T09:30:00.000Z","transactionType":"crypto","customerId":"3b241101-e2bb-4255-8caf-4136c566a962","transactionInfo":{"hash":"example","blockchainChainId":"example","direction":"IN","amount":"example","currencyCode":"example","hashUrl":"https://example.com/resource"},"transactionAmounts":[],"transactionReview":{"riskLevel":"Low","status":"pending"},"originator":{"partyId":"example","name":"Jane Doe","type":"individual","transactionMethod":{"type":"card","accountId":"example"},"institution":{"name":"Jane Doe"},"address":{"country":"AFG"}},"beneficiary":{"partyId":"example","name":"Jane Doe","type":"individual","transactionMethod":{"type":"card","accountId":"example"},"institution":{"name":"Jane Doe"},"address":{"country":"AFG"}}}],"tagsToEntity":[{"id":"tte_3b241101e2bb42558caf4136","tagId":"example","entityId":"example","entityType":"transactionReview","createdBy":"workspace","tags":{"id":"tag_3b241101e2bb42558caf4136","type":"transaction","title":"Example title","backgroundColor":"example","textColor":"example","workspaceId":"example","organizationId":"example","deletedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}],"rulesMergeOperator":"AND"}]}]}}},"default":{"$ref":"#/components/responses/error"}}}},"/workflows/{workflowId}/individuals":{"post":{"operationId":"individualScreening-addIndividualForScreening","summary":"Add individual for screening","description":"Register a single individual for screening in the workspace resolved from the API key. Creates the customer record in data-analytics under a newly generated external session id and publishes a `CUSTOMER_DATA_RECEIVED` event that drives downstream screening. Returns the generated `externalSessionId` and the ComPilot `customerId`. Fails with 409 CONFLICT when the supplied `externalId` already exists for the workspace (duplicate registration).","tags":["Individual Screening"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customerData":{"type":"array","items":{"type":"object","properties":{"customerWallet":{"type":"object","properties":{"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]},"blockchainNamespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"],"nullable":true},"verified":{"type":"boolean","nullable":true},"createdBy":{"type":"string"}},"required":["wallet"],"additionalProperties":false},"customerClaims":{"type":"object","properties":{"sub":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"givenName":{"type":"string","nullable":true},"familyName":{"type":"string","nullable":true},"middleName":{"type":"string","nullable":true},"nickname":{"type":"string","nullable":true},"preferredUsername":{"type":"string","nullable":true},"profile":{"type":"string","nullable":true},"picture":{"type":"string","nullable":true},"pictureBase64":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"birthdate":{"type":"string","format":"date-time"},"zoneinfo":{"type":"string","nullable":true},"locale":{"type":"string","nullable":true},"countryOfResidence":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"nationality":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"createdBy":{"type":"string"}},"additionalProperties":false},"customerDid":{"type":"object","properties":{"did":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["did"],"additionalProperties":false},"externalId":{"type":"string"},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"]},"onboardingLevel":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded"]},"riskScore":{"type":"string","enum":["Low","Medium","High","No risk"]},"phoneNumber":{"type":"object","properties":{"phoneNumber":{"type":"string"},"verified":{"type":"boolean","nullable":true}},"required":["phoneNumber"],"additionalProperties":false},"email":{"type":"object","properties":{"email":{"type":"string","format":"email"},"verified":{"type":"boolean","nullable":true}},"required":["email"],"additionalProperties":false},"ipAddress":{"type":"string"}},"additionalProperties":false}},"customerDocument":{"type":"object","properties":{"workflowSessionId":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"mimetype":{"type":"string"},"documentType":{"type":"string","enum":["id_image_front","id_image_back","selfie_image","proof_of_residence","company_document","video_kyc"]},"existingDocumentKey":{"type":"string"},"metadata":{"anyOf":[{"type":"object","properties":{"sumsubImageId":{"type":"number"},"mediaType":{"type":"string","enum":["image/jpg","image/jpeg","image/png","application/pdf","video/mp4","video/webm","video/quicktime"]},"journeyId":{"type":"string"},"documentType":{"type":"string","enum":["INCORPORATION_CERT","INCORPORATION_ARTICLES","SHAREHOLDER_REGISTRY","INFORMATION_STATEMENT","TRUST_AGREEMENT","STATE_REGISTRY","OFFICERS_REGISTER","BOARD_RESOLUTION"]},"name":{"type":"string"},"entryDate":{"type":"integer"},"entryTime":{"type":"string"},"isSandbox":{"type":"boolean"},"status":{"type":"string","enum":["ACCEPTED","DECLINED","IN_REVIEW"]},"reviewResult":{"type":"object","properties":{"reviewAnswer":{"type":"string","enum":["GREEN","RED","YELLOW"]},"moderationComment":{"type":"string"},"clientComment":{"type":"string"},"rejectLabels":{"type":"array","items":{"type":"string","enum":["FORGERY","DOCUMENT_TEMPLATE","LOW_QUALITY","SPAM","NOT_DOCUMENT","SELFIE_MISMATCH","ID_INVALID","FOREIGNER","DUPLICATE","BAD_AVATAR","WRONG_USER_REGION","INCOMPLETE_DOCUMENT","BLACKLIST","BLOCKLIST","UNSATISFACTORY_PHOTOS","DOCUMENT_PAGE_MISSING","DOCUMENT_DAMAGED","DIGITAL_DOCUMENT","REGULATIONS_VIOLATIONS","INCONSISTENT_PROFILE","PROBLEMATIC_APPLICANT_DATA","ADDITIONAL_DOCUMENT_REQUIRED","AGE_REQUIREMENT_MISMATCH","EXPERIENCE_REQUIREMENT_MISMATCH","CRIMINAL","WRONG_ADDRESS","GRAPHIC_EDITOR","DOCUMENT_DEPRIVED","COMPROMISED_PERSONS","PEP","ADVERSE_MEDIA","FRAUDULENT_PATTERNS","SANCTIONS","NOT_ALL_CHECKS_COMPLETED","FRONT_SIDE_MISSING","BACK_SIDE_MISSING","SCREENSHOTS","BLACK_AND_WHITE","INCOMPATIBLE_LANGUAGE","EXPIRATION_DATE","UNFILLED_ID","BAD_SELFIE","BAD_VIDEO_SELFIE","BAD_FACE_MATCHING","BAD_PROOF_OF_IDENTITY","BAD_PROOF_OF_ADDRESS","BAD_PROOF_OF_PAYMENT","SELFIE_WITH_PAPER","FRAUDULENT_LIVENESS","OTHER","REQUESTED_DATA_MISMATCH","OK","COMPANY_NOT_DEFINED_STRUCTURE","COMPANY_NOT_DEFINED_BENEFICIARIES","COMPANY_NOT_VALIDATED_BENEFICIAL_OWNERS","COMPANY_NOT_VALIDATED_BENEFICIARIES","COMPANY_NOT_VALIDATED_DIRECTORS","COMPANY_NOT_DEFINED_REPRESENTATIVES","COMPANY_NOT_VALIDATED_REPRESENTATIVES","COMPANY_INCORRECT_DATA","UNSUITABLE_DOCUMENT","OUTDATED_DOCUMENT_VERSION","COMPANY_NOT_DEFINED_OWNERSHIP_STRUCTURE","COMPANY_INACTIVE_ENTITY","APPLICANT_INTERRUPTED_INTERVIEW","DOCUMENT_MISSING","UNSUITABLE_ENV","CONNECTION_INTERRUPTED","UNSUPPORTED_LANGUAGE","THIRD_PARTY_INVOLVED","CHECK_UNAVAILABLE","DB_DATA_NOT_FOUND","DB_DATA_MISMATCH","INCORRECT_SOCIAL_NUMBER"]}},"reviewRejectType":{"type":"string","enum":["FINAL","RETRY"]}},"additionalProperties":false,"nullable":true},"deactivated":{"type":"boolean"}},"required":["sumsubImageId","mediaType","journeyId","documentType","entryDate","entryTime","isSandbox"],"additionalProperties":false},{"type":"object","properties":{"source":{"type":"string","enum":["manual_beneficiary_attestation"]},"documentType":{"type":"string","enum":["INCORPORATION_CERT","INCORPORATION_ARTICLES","SHAREHOLDER_REGISTRY","INFORMATION_STATEMENT","TRUST_AGREEMENT","STATE_REGISTRY","OFFICERS_REGISTER","BOARD_RESOLUTION"]},"journeyId":{"type":"string","format":"uuid"},"uploadedBy":{"type":"string"},"mediaType":{"type":"string","enum":["image/jpg","image/jpeg","image/png","application/pdf"]},"name":{"type":"string"}},"required":["source","documentType","journeyId","uploadedBy","mediaType","name"],"additionalProperties":false},{"type":"object","properties":{"journeyId":{"type":"string","format":"uuid","description":"The ID of the journey that this credential is associated with"},"country":{"type":"string","enum":["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"],"description":"The country of residence - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)"},"name":{"type":"string","description":"Name of the document (e.g. ProofOfResidence.jpg)"},"documentType":{"type":"string","enum":["Gas_bill","Internet_bill","Electricity_bill","Rent_agreement","Bank_statement","Not_specified"],"description":"Type of the document (e.g. Gas bill, Internet bill, Electricity bill, Rent agreement, Bank statement)"},"entryDate":{"type":"integer","description":"Entry date associated with the credential"},"entryTime":{"type":"string","description":"Entry time associated with the credential"},"mediaType":{"type":"string","enum":["image/jpeg","image/jpg","image/png","application/pdf"],"description":"Media type of the document (e.g. image/jpeg, image/png, application/pdf)"},"county":{"type":"string","description":"The county of residence"},"city":{"type":"string","description":"The city of residence"},"streetName":{"type":"string","description":"The street name of residence"},"postalCode":{"type":"string","description":"The postal code of residence"},"isSandbox":{"type":"boolean","description":"Indicates if the credential was generated in a sandbox environment"}},"required":["journeyId","documentType","entryDate","entryTime"],"additionalProperties":false,"description":"Stores the data of the credential"},{"type":"object","properties":{"id":{"type":"string"},"journeyId":{"type":"string"},"reviewStatus":{"type":"string"},"roomId":{"type":"string"},"moderatorDisplayName":{"type":"string"}},"required":["id","journeyId","reviewStatus","roomId","moderatorDisplayName"],"additionalProperties":false},{"type":"object","properties":{"credentialId":{"type":"string"},"journeyId":{"type":"string"},"reviewStatus":{"type":"string","enum":["GREEN","RED","YELLOW"]},"verificationMode":{"type":"string","enum":["full_verification","sandbox"],"description":"The verification mode of the project"},"documentType":{"type":"string","enum":["ID_CARD","PASSPORT","DRIVERS","RESIDENCE_PERMIT","UTILITY_BILL","SELFIE","VIDEO_SELFIE","PROFILE_IMAGE","ID_DOC_PHOTO","AGREEMENT","CONTRACT","DRIVERS_TRANSLATION","INVESTOR_DOC","VEHICLE_REGISTRATION_CERTIFICATE","INCOME_SOURCE","PAYMENT_METHOD","BANK_CARD","COVID_VACCINATION_FORM","OTHER"]}},"required":["credentialId","journeyId","reviewStatus","verificationMode","documentType"],"additionalProperties":false},{"type":"object","properties":{"credentialId":{"type":"string"},"journeyId":{"type":"string"},"reviewStatus":{"type":"string","enum":["GREEN","RED","YELLOW"]},"verificationMode":{"type":"string","enum":["full_verification","sandbox"],"description":"The verification mode of the project"}},"required":["credentialId","journeyId","reviewStatus","verificationMode"],"additionalProperties":false}]}},"required":["fileName","mimetype","documentType","metadata"],"additionalProperties":false},"customerPersonalData":{"type":"object","properties":{"credentials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false}},"requestIp":{"type":"string","nullable":true},"address":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}],"nullable":true}},"required":["credentials"],"additionalProperties":false},"workspaceId":{"type":"string"},"organizationId":{"type":"string"},"contactInformation":{"type":"object","properties":{"email":{"type":"string","format":"email"},"phone":{"type":"string","minLength":4,"maxLength":32},"twitter":{"type":"string"},"discord":{"type":"string"},"telegram":{"type":"string"}},"additionalProperties":false},"customerPersonalInformation":{"type":"object","properties":{"age":{"type":"number"},"nationality":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)"},"residence":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)"}},"additionalProperties":false}},"required":["workspaceId","organizationId"],"additionalProperties":false},"example":{"customerData":[{"customerWallet":{"wallet":"example","blockchainNamespace":"tezos","verified":true,"createdBy":"workspace"},"customerClaims":{"sub":"example","name":"Jane Doe","givenName":"Jane Doe","familyName":"Jane Doe","middleName":"Jane Doe","nickname":"Jane Doe","preferredUsername":"Jane Doe","profile":"example","picture":"example","pictureBase64":"example","website":"example","gender":"example","birthdate":"2024-05-14T09:30:00.000Z","zoneinfo":"example","locale":"example","countryOfResidence":"AFG","nationality":"AFG","createdBy":"workspace"},"customerDid":{"did":"example","createdBy":"workspace","updatedBy":"workspace"},"externalId":"example","status":"Active","onboardingLevel":"Started","riskScore":"Low","phoneNumber":{"phoneNumber":"+4915112345678","verified":true},"email":{"email":"jane.doe@example.com","verified":true},"ipAddress":"203.0.113.42"}],"customerDocument":{"workflowSessionId":"3b241101-e2bb-4255-8caf-4136c566a962","fileName":"Jane Doe","mimetype":"DEFAULT","documentType":"id_image_front","existingDocumentKey":"key_example_0001","metadata":{"sumsubImageId":42,"mediaType":"image/jpg","journeyId":"example","documentType":"INCORPORATION_CERT","name":"Jane Doe","entryDate":42,"entryTime":"example","isSandbox":true,"status":"ACCEPTED","reviewResult":{"reviewAnswer":"GREEN","moderationComment":"Example description","clientComment":"Example description","rejectLabels":["FORGERY"],"reviewRejectType":"FINAL"},"deactivated":true}},"customerPersonalData":{"credentials":[{"id":"example","@context":["example"],"type":["DEFAULT"],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}}],"requestIp":"203.0.113.42","address":"Alexanderplatz 1, 10178 Berlin, Germany"},"workspaceId":"example","organizationId":"example","contactInformation":{"email":"jane.doe@example.com","phone":"+4915112345678","twitter":"example","discord":"example","telegram":"example"},"customerPersonalInformation":{"age":42,"nationality":"AFG","residence":"AFG"}}}}},"parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"example":"3b241101-e2bb-4255-8caf-4136c566a962"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"msg":{"type":"string"},"externalSessionId":{"type":"string"},"customerId":{"type":"string"}},"required":["msg","externalSessionId","customerId"],"additionalProperties":false},"example":{"msg":"example","externalSessionId":"example","customerId":"example"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/workflows/{workflowId}/individuals/batch":{"post":{"operationId":"individualScreening-addIndividualsForScreening","summary":"Add individuals for screening","description":"Batch variant of add-individual-for-screening: registers many individuals in the workspace resolved from the API key. Each individual is created in data-analytics under its own generated external session id and a `CUSTOMER_DATA_RECEIVED` event is published per individual to drive downstream screening. Fails with 409 CONFLICT if any individual's `externalId` already exists for the workspace; the batch is not guaranteed atomic, so earlier individuals may already have been registered before a later conflict is raised.","tags":["Individual Screening"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"individuals":{"type":"array","items":{"type":"object","properties":{"customerData":{"type":"array","items":{"type":"object","properties":{"customerWallet":{"type":"object","properties":{"wallet":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]},"blockchainNamespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"],"nullable":true},"verified":{"type":"boolean","nullable":true},"createdBy":{"type":"string"}},"required":["wallet"],"additionalProperties":false},"customerClaims":{"type":"object","properties":{"sub":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"givenName":{"type":"string","nullable":true},"familyName":{"type":"string","nullable":true},"middleName":{"type":"string","nullable":true},"nickname":{"type":"string","nullable":true},"preferredUsername":{"type":"string","nullable":true},"profile":{"type":"string","nullable":true},"picture":{"type":"string","nullable":true},"pictureBase64":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"birthdate":{"type":"string","format":"date-time"},"zoneinfo":{"type":"string","nullable":true},"locale":{"type":"string","nullable":true},"countryOfResidence":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"nationality":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)","nullable":true},"createdBy":{"type":"string"}},"additionalProperties":false},"customerDid":{"type":"object","properties":{"did":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}},"required":["did"],"additionalProperties":false},"externalId":{"type":"string"},"status":{"type":"string","enum":["Active","Rejected","Dormant","To be reviewed","Failed","Escalated","Terminated","No status"]},"onboardingLevel":{"type":"string","enum":["Started","Sign-up","AML screening","KYC","Questionaire","Onboarded"]},"riskScore":{"type":"string","enum":["Low","Medium","High","No risk"]},"phoneNumber":{"type":"object","properties":{"phoneNumber":{"type":"string"},"verified":{"type":"boolean","nullable":true}},"required":["phoneNumber"],"additionalProperties":false},"email":{"type":"object","properties":{"email":{"type":"string","format":"email"},"verified":{"type":"boolean","nullable":true}},"required":["email"],"additionalProperties":false},"ipAddress":{"type":"string"}},"additionalProperties":false}},"customerDocument":{"type":"object","properties":{"workflowSessionId":{"type":"string","format":"uuid"},"fileName":{"type":"string"},"mimetype":{"type":"string"},"documentType":{"type":"string","enum":["id_image_front","id_image_back","selfie_image","proof_of_residence","company_document","video_kyc"]},"existingDocumentKey":{"type":"string"},"metadata":{"anyOf":[{"type":"object","properties":{"sumsubImageId":{"type":"number"},"mediaType":{"type":"string","enum":["image/jpg","image/jpeg","image/png","application/pdf","video/mp4","video/webm","video/quicktime"]},"journeyId":{"type":"string"},"documentType":{"type":"string","enum":["INCORPORATION_CERT","INCORPORATION_ARTICLES","SHAREHOLDER_REGISTRY","INFORMATION_STATEMENT","TRUST_AGREEMENT","STATE_REGISTRY","OFFICERS_REGISTER","BOARD_RESOLUTION"]},"name":{"type":"string"},"entryDate":{"type":"integer"},"entryTime":{"type":"string"},"isSandbox":{"type":"boolean"},"status":{"type":"string","enum":["ACCEPTED","DECLINED","IN_REVIEW"]},"reviewResult":{"type":"object","properties":{"reviewAnswer":{"type":"string","enum":["GREEN","RED","YELLOW"]},"moderationComment":{"type":"string"},"clientComment":{"type":"string"},"rejectLabels":{"type":"array","items":{"type":"string","enum":["FORGERY","DOCUMENT_TEMPLATE","LOW_QUALITY","SPAM","NOT_DOCUMENT","SELFIE_MISMATCH","ID_INVALID","FOREIGNER","DUPLICATE","BAD_AVATAR","WRONG_USER_REGION","INCOMPLETE_DOCUMENT","BLACKLIST","BLOCKLIST","UNSATISFACTORY_PHOTOS","DOCUMENT_PAGE_MISSING","DOCUMENT_DAMAGED","DIGITAL_DOCUMENT","REGULATIONS_VIOLATIONS","INCONSISTENT_PROFILE","PROBLEMATIC_APPLICANT_DATA","ADDITIONAL_DOCUMENT_REQUIRED","AGE_REQUIREMENT_MISMATCH","EXPERIENCE_REQUIREMENT_MISMATCH","CRIMINAL","WRONG_ADDRESS","GRAPHIC_EDITOR","DOCUMENT_DEPRIVED","COMPROMISED_PERSONS","PEP","ADVERSE_MEDIA","FRAUDULENT_PATTERNS","SANCTIONS","NOT_ALL_CHECKS_COMPLETED","FRONT_SIDE_MISSING","BACK_SIDE_MISSING","SCREENSHOTS","BLACK_AND_WHITE","INCOMPATIBLE_LANGUAGE","EXPIRATION_DATE","UNFILLED_ID","BAD_SELFIE","BAD_VIDEO_SELFIE","BAD_FACE_MATCHING","BAD_PROOF_OF_IDENTITY","BAD_PROOF_OF_ADDRESS","BAD_PROOF_OF_PAYMENT","SELFIE_WITH_PAPER","FRAUDULENT_LIVENESS","OTHER","REQUESTED_DATA_MISMATCH","OK","COMPANY_NOT_DEFINED_STRUCTURE","COMPANY_NOT_DEFINED_BENEFICIARIES","COMPANY_NOT_VALIDATED_BENEFICIAL_OWNERS","COMPANY_NOT_VALIDATED_BENEFICIARIES","COMPANY_NOT_VALIDATED_DIRECTORS","COMPANY_NOT_DEFINED_REPRESENTATIVES","COMPANY_NOT_VALIDATED_REPRESENTATIVES","COMPANY_INCORRECT_DATA","UNSUITABLE_DOCUMENT","OUTDATED_DOCUMENT_VERSION","COMPANY_NOT_DEFINED_OWNERSHIP_STRUCTURE","COMPANY_INACTIVE_ENTITY","APPLICANT_INTERRUPTED_INTERVIEW","DOCUMENT_MISSING","UNSUITABLE_ENV","CONNECTION_INTERRUPTED","UNSUPPORTED_LANGUAGE","THIRD_PARTY_INVOLVED","CHECK_UNAVAILABLE","DB_DATA_NOT_FOUND","DB_DATA_MISMATCH","INCORRECT_SOCIAL_NUMBER"]}},"reviewRejectType":{"type":"string","enum":["FINAL","RETRY"]}},"additionalProperties":false,"nullable":true},"deactivated":{"type":"boolean"}},"required":["sumsubImageId","mediaType","journeyId","documentType","entryDate","entryTime","isSandbox"],"additionalProperties":false},{"type":"object","properties":{"source":{"type":"string","enum":["manual_beneficiary_attestation"]},"documentType":{"type":"string","enum":["INCORPORATION_CERT","INCORPORATION_ARTICLES","SHAREHOLDER_REGISTRY","INFORMATION_STATEMENT","TRUST_AGREEMENT","STATE_REGISTRY","OFFICERS_REGISTER","BOARD_RESOLUTION"]},"journeyId":{"type":"string","format":"uuid"},"uploadedBy":{"type":"string"},"mediaType":{"type":"string","enum":["image/jpg","image/jpeg","image/png","application/pdf"]},"name":{"type":"string"}},"required":["source","documentType","journeyId","uploadedBy","mediaType","name"],"additionalProperties":false},{"type":"object","properties":{"journeyId":{"type":"string","format":"uuid","description":"The ID of the journey that this credential is associated with"},"country":{"type":"string","enum":["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"],"description":"The country of residence - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)"},"name":{"type":"string","description":"Name of the document (e.g. ProofOfResidence.jpg)"},"documentType":{"type":"string","enum":["Gas_bill","Internet_bill","Electricity_bill","Rent_agreement","Bank_statement","Not_specified"],"description":"Type of the document (e.g. Gas bill, Internet bill, Electricity bill, Rent agreement, Bank statement)"},"entryDate":{"type":"integer","description":"Entry date associated with the credential"},"entryTime":{"type":"string","description":"Entry time associated with the credential"},"mediaType":{"type":"string","enum":["image/jpeg","image/jpg","image/png","application/pdf"],"description":"Media type of the document (e.g. image/jpeg, image/png, application/pdf)"},"county":{"type":"string","description":"The county of residence"},"city":{"type":"string","description":"The city of residence"},"streetName":{"type":"string","description":"The street name of residence"},"postalCode":{"type":"string","description":"The postal code of residence"},"isSandbox":{"type":"boolean","description":"Indicates if the credential was generated in a sandbox environment"}},"required":["journeyId","documentType","entryDate","entryTime"],"additionalProperties":false,"description":"Stores the data of the credential"},{"type":"object","properties":{"id":{"type":"string"},"journeyId":{"type":"string"},"reviewStatus":{"type":"string"},"roomId":{"type":"string"},"moderatorDisplayName":{"type":"string"}},"required":["id","journeyId","reviewStatus","roomId","moderatorDisplayName"],"additionalProperties":false},{"type":"object","properties":{"credentialId":{"type":"string"},"journeyId":{"type":"string"},"reviewStatus":{"type":"string","enum":["GREEN","RED","YELLOW"]},"verificationMode":{"type":"string","enum":["full_verification","sandbox"],"description":"The verification mode of the project"},"documentType":{"type":"string","enum":["ID_CARD","PASSPORT","DRIVERS","RESIDENCE_PERMIT","UTILITY_BILL","SELFIE","VIDEO_SELFIE","PROFILE_IMAGE","ID_DOC_PHOTO","AGREEMENT","CONTRACT","DRIVERS_TRANSLATION","INVESTOR_DOC","VEHICLE_REGISTRATION_CERTIFICATE","INCOME_SOURCE","PAYMENT_METHOD","BANK_CARD","COVID_VACCINATION_FORM","OTHER"]}},"required":["credentialId","journeyId","reviewStatus","verificationMode","documentType"],"additionalProperties":false},{"type":"object","properties":{"credentialId":{"type":"string"},"journeyId":{"type":"string"},"reviewStatus":{"type":"string","enum":["GREEN","RED","YELLOW"]},"verificationMode":{"type":"string","enum":["full_verification","sandbox"],"description":"The verification mode of the project"}},"required":["credentialId","journeyId","reviewStatus","verificationMode"],"additionalProperties":false}]}},"required":["fileName","mimetype","documentType","metadata"],"additionalProperties":false},"customerPersonalData":{"type":"object","properties":{"credentials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"type":"object","additionalProperties":{}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["SparseMerkleTreeProof","Iden3ReverseSparseMerkleTreeProof","Iden3commRevocationStatusV1.0","Iden3OnchainSparseMerkleTreeProof2023"]},"revocationNonce":{"type":"number"}},"required":["id","type"],"additionalProperties":false},"issuer":{"type":"string"},"credentialSchema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"additionalProperties":false},"proof":{}},"required":["id","type","credentialSubject","credentialStatus","issuer","credentialSchema"],"additionalProperties":false}},"requestIp":{"type":"string","nullable":true},"address":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}],"nullable":true}},"required":["credentials"],"additionalProperties":false},"workflowId":{"type":"string","format":"uuid"},"workspaceId":{"type":"string"},"organizationId":{"type":"string"},"contactInformation":{"type":"object","properties":{"email":{"type":"string","format":"email"},"phone":{"type":"string","minLength":4,"maxLength":32},"twitter":{"type":"string"},"discord":{"type":"string"},"telegram":{"type":"string"}},"additionalProperties":false},"customerPersonalInformation":{"type":"object","properties":{"age":{"type":"number"},"nationality":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)"},"residence":{"type":"string","enum":["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"],"description":"Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)"}},"additionalProperties":false}},"required":["workflowId","workspaceId","organizationId"],"additionalProperties":false}}},"required":["individuals"],"additionalProperties":false},"example":{"individuals":[{"customerData":[{"customerWallet":{"wallet":"example","blockchainNamespace":"tezos","verified":true,"createdBy":"workspace"},"customerClaims":{"sub":"example","name":"Jane Doe","givenName":"Jane Doe","familyName":"Jane Doe","middleName":"Jane Doe","nickname":"Jane Doe","preferredUsername":"Jane Doe","profile":"example","picture":"example","pictureBase64":"example","website":"example","gender":"example","birthdate":"2024-05-14T09:30:00.000Z","zoneinfo":"example","locale":"example","countryOfResidence":"AFG","nationality":"AFG","createdBy":"workspace"},"customerDid":{"did":"example","createdBy":"workspace","updatedBy":"workspace"},"externalId":"example","status":"Active","onboardingLevel":"Started","riskScore":"Low","phoneNumber":{"phoneNumber":"+4915112345678","verified":true},"email":{"email":"jane.doe@example.com","verified":true},"ipAddress":"203.0.113.42"}],"customerDocument":{"workflowSessionId":"3b241101-e2bb-4255-8caf-4136c566a962","fileName":"Jane Doe","mimetype":"DEFAULT","documentType":"id_image_front","existingDocumentKey":"key_example_0001","metadata":{"sumsubImageId":42,"mediaType":"image/jpg","journeyId":"example","documentType":"INCORPORATION_CERT","name":"Jane Doe","entryDate":42,"entryTime":"example","isSandbox":true,"status":"ACCEPTED","reviewResult":{"reviewAnswer":"GREEN","moderationComment":"Example description","clientComment":"Example description","rejectLabels":["FORGERY"],"reviewRejectType":"FINAL"},"deactivated":true}},"customerPersonalData":{"credentials":[{"id":"example","@context":["example"],"type":["DEFAULT"],"expirationDate":"example","issuanceDate":"example","credentialSubject":{"exampleKey":{}},"credentialStatus":{"id":"example","type":"SparseMerkleTreeProof","revocationNonce":42},"issuer":"example","credentialSchema":{"id":"example","type":"DEFAULT"},"proof":{}}],"requestIp":"203.0.113.42","address":"Alexanderplatz 1, 10178 Berlin, Germany"},"workflowId":"3b241101-e2bb-4255-8caf-4136c566a962","workspaceId":"example","organizationId":"example","contactInformation":{"email":"jane.doe@example.com","phone":"+4915112345678","twitter":"example","discord":"example","telegram":"example"},"customerPersonalInformation":{"age":42,"nationality":"AFG","residence":"AFG"}}]}}}},"parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string"},"example":"example"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"msg":{"type":"string"}},"required":["msg"],"additionalProperties":false},"example":{"msg":"example"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/tags/{id}":{"get":{"operationId":"tagsRouter-getTagById","summary":"Get tag by id","description":"Get a tag by its id.","tags":["Tags"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"example"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string"},"workspaceId":{"type":"string"},"backgroundColor":{"type":"string"},"textColor":{"type":"string"}},"required":["type","id","createdAt","updatedAt","title","workspaceId","backgroundColor","textColor"],"additionalProperties":false},"example":{"type":"DEFAULT","id":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","title":"Example title","workspaceId":"example","backgroundColor":"example","textColor":"example"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/tags":{"post":{"operationId":"tagsRouter-createTag","summary":"Create tag","description":"Create a new tag.","tags":["Tags"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"array","items":{"type":"string","enum":["transaction","individual","company","wallet"]},"minItems":1},"title":{"type":"string","minLength":1,"maxLength":120},"backgroundColor":{"type":"string"},"textColor":{"type":"string"},"workspaceId":{"type":"string"},"organizationId":{"type":"string"},"createdBy":{"type":"string"}},"required":["type","title","backgroundColor","textColor","workspaceId","organizationId"],"additionalProperties":false},"example":{"type":["transaction"],"title":"Example title","backgroundColor":"example","textColor":"example","workspaceId":"example","organizationId":"example","createdBy":"workspace"}}}},"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{}},"required":["id"],"additionalProperties":false}},"example":[{"id":"tag_3b241101e2bb42558caf4136"}]}}},"default":{"$ref":"#/components/responses/error"}}}},"/workspace/{workspaceId}/tags":{"get":{"operationId":"tagsRouter-listTags","summary":"Get list of tags","description":"Get the list of tags.","tags":["Tags"],"security":[{"Authorization":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"},"example":"example"},{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["transaction","individual","company","wallet"]},"example":"transaction"},{"name":"currentPage","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"number"}],"default":0},"example":0},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"number"}],"default":10},"example":10}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"totalCount":{"type":"number"},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"array","items":{"type":"string","enum":["transaction","individual","company","wallet"]}},"id":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string"},"workspaceId":{"type":"string"},"backgroundColor":{"type":"string"},"textColor":{"type":"string"}},"required":["type","id","createdAt","updatedAt","title","workspaceId","backgroundColor","textColor"],"additionalProperties":false}}},"required":["totalCount","data"],"additionalProperties":false},"example":{"totalCount":42,"data":[{"type":["transaction"],"id":"tag_3b241101e2bb42558caf4136","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","title":"Example title","workspaceId":"example","backgroundColor":"example","textColor":"example"}]}}}},"default":{"$ref":"#/components/responses/error"}}}},"/workspace/{workspaceId}/tags/type/{type}":{"get":{"operationId":"tagsRouter-listTagsByType","summary":"Get list of tags by type","description":"Get the list of tags by type.","tags":["Tags"],"security":[{"Authorization":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"},"example":"example"},{"name":"type","in":"path","required":true,"schema":{"type":"string","enum":["transaction","individual","company","wallet"]},"example":"transaction"},{"name":"currentPage","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"number"}],"default":0},"example":0},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"number"}],"default":10},"example":10}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"totalCount":{"type":"number"},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time","nullable":true},"title":{"type":"string"},"workspaceId":{"type":"string"},"backgroundColor":{"type":"string"},"textColor":{"type":"string"}},"required":["type","id","createdAt","updatedAt","title","workspaceId","backgroundColor","textColor"],"additionalProperties":false}}},"required":["totalCount","data"],"additionalProperties":false},"example":{"totalCount":42,"data":[{"type":"DEFAULT","id":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","title":"Example title","workspaceId":"example","backgroundColor":"example","textColor":"example"}]}}}},"default":{"$ref":"#/components/responses/error"}}}},"/tags/entities/{entityId}":{"get":{"operationId":"tagsRouter-listTagEntities","summary":"List tag entities","description":"Get all tag entities for a specific entity ID.","tags":["Tags"],"security":[{"Authorization":[]}],"parameters":[{"name":"entityId","in":"path","required":true,"schema":{"type":"string"},"example":"example"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time","nullable":true},"entityType":{"type":"string","enum":["customer","transactionReview","alert","wallet"]},"entityId":{"type":"string"},"tags":{"type":"object","properties":{"id":{},"type":{"type":"string","enum":["transaction","individual","company","wallet"]},"title":{"type":"string"},"backgroundColor":{"type":"string"},"textColor":{"type":"string"},"workspaceId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time","nullable":true},"deletedAt":{"type":"string","format":"date-time","nullable":true},"createdBy":{"type":"string","nullable":true},"updatedBy":{"type":"string","nullable":true}},"required":["id","type","title","backgroundColor","textColor","workspaceId","createdAt"],"additionalProperties":false}},"required":["id","createdAt","updatedAt","entityType","entityId","tags"],"additionalProperties":false}},"example":[{"id":"tte_3b241101e2bb42558caf4136","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","entityType":"customer","entityId":"example","tags":{"id":"tag_3b241101e2bb42558caf4136","type":"transaction","title":"Example title","backgroundColor":"example","textColor":"example","workspaceId":"example","organizationId":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","deletedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace"}}]}}},"default":{"$ref":"#/components/responses/error"}}}},"/workspace/{workspaceId}/tags/audits":{"get":{"operationId":"tagsRouter-getTagAudits","summary":"Get tag audit logs","description":"Get audit logs for all tags in a workspace.","tags":["Tags"],"security":[{"Authorization":[]}],"parameters":[{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"},"example":"example"},{"name":"currentPage","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"number"}],"default":0},"example":0},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"not":{}},{"type":"number"}],"default":10},"example":10},{"name":"tagTitle","in":"query","required":false,"schema":{"type":"string"},"example":"Example title"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"audits":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"action":{"type":"string","enum":["create","update","delete","attach","detach","duplicate"]},"author":{"type":"string","nullable":true},"record":{"type":"object","properties":{"id":{},"type":{"type":"string","enum":["transaction","individual","company","wallet"]},"title":{"type":"string"},"backgroundColor":{"type":"string"},"textColor":{"type":"string"},"workspaceId":{"type":"string"},"organizationId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time","nullable":true},"deletedAt":{"type":"string","format":"date-time","nullable":true},"createdBy":{"type":"string","nullable":true},"updatedBy":{"type":"string","nullable":true},"oldTitle":{"type":"string"}},"additionalProperties":false},"tagId":{"type":"string"},"tagTitle":{"type":"string","nullable":true},"addedEntityTypes":{"type":"array","items":{"type":"string"}},"removedEntityTypes":{"type":"array","items":{"type":"string"}}},"required":["timestamp","action","record","tagId"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["audits","totalCount"],"additionalProperties":false},"example":{"audits":[{"timestamp":"2024-05-14T09:30:00.000Z","action":"create","author":"example","record":{"id":"tag_3b241101e2bb42558caf4136","type":"transaction","title":"Example title","backgroundColor":"example","textColor":"example","workspaceId":"example","organizationId":"example","createdAt":"2024-05-14T09:30:00.000Z","updatedAt":"2024-05-14T09:30:00.000Z","deletedAt":"2024-05-14T09:30:00.000Z","createdBy":"workspace","updatedBy":"workspace","oldTitle":"Example title"},"tagId":"example","tagTitle":"Example title","addedEntityTypes":["DEFAULT"],"removedEntityTypes":["DEFAULT"]}],"totalCount":42}}}},"default":{"$ref":"#/components/responses/error"}}}},"/workspace/{workspaceId}/tags/{title}":{"delete":{"operationId":"tagsRouter-deleteTag","summary":"Delete tag","description":"Delete tags based on name and workspaceId.","tags":["Tags"],"security":[{"Authorization":[]}],"parameters":[{"name":"title","in":"path","required":true,"schema":{"type":"string"},"example":"Example title"},{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"},"example":"example"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"default":{"$ref":"#/components/responses/error"}}},"patch":{"operationId":"tagsRouter-updateTag","summary":"Update tag","description":"Update a tag based on its name and workspaceId.","tags":["Tags"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string"},"data":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"backgroundColor":{"type":"string"},"textColor":{"type":"string"},"type":{"type":"array","items":{"type":"string","enum":["transaction","individual","company","wallet"]},"minItems":1}},"required":["type"],"additionalProperties":false},"updatedBy":{"type":"string"}},"required":["organizationId","data"],"additionalProperties":false},"example":{"organizationId":"example","data":{"title":"Example title","backgroundColor":"example","textColor":"example","type":["transaction"]},"updatedBy":"workspace"}}}},"parameters":[{"name":"title","in":"path","required":true,"schema":{"type":"string"},"example":"Example title"},{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string"},"example":"example"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"updatedIds":{"type":"array","items":{}}},"required":["updatedIds"],"additionalProperties":false},"example":{"updatedIds":["tag_3b241101e2bb42558caf4136"]}}}},"default":{"$ref":"#/components/responses/error"}}}},"/healthcheck":{"get":{"operationId":"healthcheck","summary":"Healthcheck","description":"Liveness probe. Returns the literal string `OK` with HTTP 200 when the API process is up and able to serve requests. Unauthenticated; safe for load balancers, uptime monitors, and container orchestrators. Does not touch the database or downstream services.","tags":["System"],"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string","enum":["OK"]},"example":"OK"}}},"default":{"$ref":"#/components/responses/error"}}}},"/information":{"get":{"operationId":"information","summary":"Information","description":"Returns public runtime configuration needed by API consumers to verify signed payloads. `signatureSignerAddress` is the EVM address that signs ComPilot-issued transaction/authorization data; clients recover this address from a signature to confirm a payload originated from ComPilot. Unauthenticated and stable per environment.","tags":["System"],"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"signatureSignerAddress":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"anyOf":[{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"}]},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"anyOf":[{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]}]}},"required":["signatureSignerAddress"],"additionalProperties":false},"example":{"signatureSignerAddress":"0x1111111111111111111111111111111111111111"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/version":{"get":{"operationId":"versions","summary":"Version","description":"Returns the deployed build version (git commit SHA) of the API and related services, for support, incident diagnosis, and cache-busting. `api` is the live commit SHA of this service; the remaining fields are placeholders (`TODO`) reserved for sibling service versions and are not yet populated. Unauthenticated.","tags":["System"],"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"api":{"type":"string"},"dataAnalytics":{"type":"string"},"identityApp":{"type":"string"},"dashboard":{"type":"string"},"blockchainApi":{"type":"string"},"zkVerifier":{"type":"string"}},"required":["api","dataAnalytics","identityApp","dashboard","blockchainApi","zkVerifier"],"additionalProperties":false},"example":{"api":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","dataAnalytics":"TODO","identityApp":"TODO","dashboard":"TODO","blockchainApi":"TODO","zkVerifier":"TODO"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/identity/auth-session/wallet/challenge/verify":{"post":{"operationId":"verifyWalletChallenge","tags":["Auth"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"message":{"type":"string"},"signature":{"anyOf":[{"type":"string","description":"0x string"},{"type":"string"},{"type":"string"},{"type":"string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string"}]},"signerPublicKey":{"type":"string"},"signerPublicKeyType":{"type":"string"},"signedMessage":{"type":"string"}},"required":["message","signature","signerPublicKey","signedMessage"]},{"type":"object","properties":{"address":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]},"namespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano"]},"blockchainId":{"anyOf":[{"type":"string","enum":["1","137","80002","43114","43113","42161","421614","11155111","8453","84532","56","97","1284","1285","10","11155420","1291","295","296","254","2024","20241133","9990","3338","2040","78600","72080","50","51"],"description":"a numeric value that identifies the chain of the address. There are many sites that retrieve information on chainIDs such as <a href='https://chainlist.org/'>https://chainlist.org</a>."},{"type":"string","enum":["NetXdQprcVkpaWU","NetXnHfVqm9iesp"],"description":"a numeric value that identifies the chain of the address. There are many sites that retrieve information on chainIDs such as <a href='https://chainlist.org/'>https://chainlist.org</a>."},{"type":"string","enum":["cosmoshub-4","theta-testnet-001"],"description":"a value that identifies the chain of the address."},{"type":"string","enum":["0x534e5f4d41494e","0x534e5f5345504f4c4941"],"description":"a value that identifies the chain of the address."},{"type":"string","enum":["mainnet-bitcoin","testnet-bitcoin"],"description":"a value that identifies the chain of the address."},{"type":"string","enum":["mainnet-aptos","testnet-aptos"],"description":"a value that identifies the chain of the address."},{"type":"string","enum":["polkadot-relay-chain","kusama-relay-chain","polkadot-testnet"],"description":"a value that identifies the chain of the address."},{"type":"string","enum":["solana-mainnet","solana-testnet","solana-devnet"],"description":"a value that identifies the chain of the address."},{"type":"string","enum":["cardano-mainnet","cardano-testnet"],"description":"a value that identifies the chain of the address."}]}},"required":["address","namespace"]}]}}}},"responses":{"200":{"description":"Generate an api access token for the given signed challenge","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"},"expiresAt":{"type":"number"},"externalCustomerId":{"type":"string"},"identitySessionId":{}},"required":["token","expiresAt"]}}}},"401":{"description":"Invalid signature","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"404":{"description":"Challenge not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/identity/auth-session/wallet/challenge/create":{"post":{"operationId":"createWalletChallenge","security":[{"workspaceApiKey":[]}],"tags":["Auth"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"address":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]},"namespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano"]},"blockchainId":{"anyOf":[{"type":"string","enum":["1","137","80002","43114","43113","42161","421614","11155111","8453","84532","56","97","1284","1285","10","11155420","1291","295","296","254","2024","20241133","9990","3338","2040","78600","72080","50","51"],"description":"a numeric value that identifies the chain of the address. There are many sites that retrieve information on chainIDs such as <a href='https://chainlist.org/'>https://chainlist.org</a>."},{"type":"string","enum":["NetXdQprcVkpaWU","NetXnHfVqm9iesp"],"description":"a numeric value that identifies the chain of the address. There are many sites that retrieve information on chainIDs such as <a href='https://chainlist.org/'>https://chainlist.org</a>."},{"type":"string","enum":["cosmoshub-4","theta-testnet-001"],"description":"a value that identifies the chain of the address."},{"type":"string","enum":["0x534e5f4d41494e","0x534e5f5345504f4c4941"],"description":"a value that identifies the chain of the address."},{"type":"string","enum":["mainnet-bitcoin","testnet-bitcoin"],"description":"a value that identifies the chain of the address."},{"type":"string","enum":["mainnet-aptos","testnet-aptos"],"description":"a value that identifies the chain of the address."},{"type":"string","enum":["polkadot-relay-chain","kusama-relay-chain","polkadot-testnet"],"description":"a value that identifies the chain of the address."},{"type":"string","enum":["solana-mainnet","solana-testnet","solana-devnet"],"description":"a value that identifies the chain of the address."},{"type":"string","enum":["cardano-mainnet","cardano-testnet"],"description":"a value that identifies the chain of the address."}]},"origin":{"type":"string","format":"uri"},"workflowId":{"type":"string","format":"uuid"},"externalCustomerId":{"type":"string"},"additionalInformation":{"type":"object","properties":{"email":{"type":"string","format":"email"},"phone":{"type":"string","minLength":4,"maxLength":32},"wallet":{"type":"object","properties":{"address":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]},"namespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"]}},"required":["address","namespace"]}}}},"required":["address","namespace","origin","workflowId"]}}}},"responses":{"200":{"description":"Get an auth challenge for a specific wallet address","content":{"application/json":{"schema":{"type":"object","properties":{"challenge":{"type":"string"}},"required":["challenge"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"404":{"description":"App not found for the given workflowId","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["App not found for the given workflowId"]}},"required":["error"]}}}}}}},"/identity/auth-session/session/create":{"post":{"operationId":"createSession","security":[{"workspaceApiKey":[]}],"tags":["Auth"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"workflowId":{"type":"string","format":"uuid"},"externalCustomerId":{"type":"string"},"additionalInformation":{"type":"object","properties":{"email":{"type":"string","format":"email"},"phone":{"type":"string","minLength":4,"maxLength":32},"wallet":{"type":"object","properties":{"address":{"anyOf":[{"type":"string","description":"String value that identifies the address of a specific user. Normally tied to an EOA that includes the Smart Wallet."},{"type":"string","description":"Tezos address (implicit account)"},{"type":"string","description":"Tezos contract address"},{"type":"string","description":"0x string"},{"type":"string"},{"type":"string","description":"0x string"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Cosmos address"},{"type":"string","description":"Bitcoin P2PKH Address"},{"type":"string","description":"Bitcoin P2SH Address"},{"type":"string","description":"Bitcoin Bech32 Address"},{"type":"string","description":"Bitcoin Testnet P2PKH Address"},{"type":"string","description":"Bitcoin Testnet P2SH Address"},{"type":"string","description":"Bitcoin Testnet Bech32 Address"}]},"namespace":{"type":"string","enum":["tezos","eip155","aptos","polkadot","starknet","cosmos","solana","cardano","bip122","xrpl","dash","tron","avax"]}},"required":["address","namespace"]}}}},"required":["workflowId","externalCustomerId"]}}}},"responses":{"200":{"description":"Generate an api access token for the given workflowId","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"},"expiresAt":{"type":"number"},"externalCustomerId":{"type":"string"},"identitySessionId":{}},"required":["token","expiresAt"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"404":{"description":"Workflow not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/identity/auth-session/session/nexera-api/create":{"post":{"operationId":"createSessionFromAPIRoute","tags":["Auth"],"security":[{"workspaceApiKey":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"workflowId":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"},"externalCustomerId":{"type":"string"}},"required":["workflowId"]}}}},"responses":{"200":{"description":"Generate an api access token for the given workflowId","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"},"expiresAt":{"type":"number"},"identitySessionId":{}},"required":["token","expiresAt"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"404":{"description":"Workflow not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/datasets/{datasetId}/rows/batch":{"post":{"security":[{"workspaceApiKey":[]}],"operationId":"createDatasetRowBatch","summary":"Create dataset rows with values batch","tags":["Datasets"],"description":"Create a batch of dataset rows with values","parameters":[{"schema":{},"required":true,"name":"datasetId","in":"path"},{"schema":{"type":"string"},"required":true,"name":"X-API-Key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object","properties":{"operation":{"type":"string","enum":["INSERT"]},"datasetColumnId":{},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"string"},{"type":"object","properties":{"fileType":{"type":"string"},"fileName":{"type":"string"},"objectKey":{"type":"string"},"documentType":{"type":"string"},"country":{"type":"string"},"county":{"type":"string"},"city":{"type":"string"},"streetName":{"type":"string"},"postalCode":{"type":"string"}},"required":["fileType","fileName","objectKey"]},{"type":"object","additionalProperties":{"nullable":true}},{"nullable":true}]},"datasetColumnOptionId":{"anyOf":[{},{},{"nullable":true}]}},"required":["operation","datasetColumnId","value","datasetColumnOptionId"]},"maxItems":100}},"required":["values"]},"maxItems":100}},"required":["rows"]}}}},"responses":{"201":{"description":"Create dataset rows with values -- success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{},"datasetId":{},"referencesFormViewId":{"type":"string","nullable":true},"graphObjectId":{"type":"string","nullable":true},"values":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"id":{},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"string"},{"type":"object","properties":{"fileType":{"type":"string"},"fileName":{"type":"string"},"objectKey":{"type":"string"},"documentType":{"type":"string"},"country":{"type":"string"},"county":{"type":"string"},"city":{"type":"string"},"streetName":{"type":"string"},"postalCode":{"type":"string"}},"required":["fileType","fileName","objectKey"]},{"type":"object","additionalProperties":{"nullable":true}},{"nullable":true}]},"datasetColumnOptionId":{"anyOf":[{},{},{"nullable":true}]},"datasetColumnTypeId":{},"optionColor":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","value","datasetColumnOptionId","createdAt","updatedAt"]}}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"bandStatuses":{"type":"array","items":{"type":"object","properties":{"columnId":{},"subjectObjectId":{"type":"string"},"status":{"type":"string","enum":["FRESH","STALE","NOT_SCORED","ERROR"]},"isCurrentRating":{"type":"boolean"},"lifecycle":{"type":"string","enum":["LIVE","SUPERSEDED","RETIRED","SHADOW","UNPUBLISHED"]},"scoredAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["columnId","subjectObjectId","status","isCurrentRating","lifecycle","scoredAt"]}}},"required":["id","datasetId","values","createdAt","updatedAt"]}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden -- read-only API key cannot perform writes"},"404":{"description":"Dataset not found"},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]}}}}}},"delete":{"security":[{"workspaceApiKey":[]}],"operationId":"deleteDatasetRowBatch","summary":"Delete dataset rows batch","tags":["Datasets"],"description":"Delete a batch of dataset rows by their IDs","parameters":[{"schema":{},"required":true,"name":"datasetId","in":"path"},{"schema":{"type":"array","items":{}},"required":true,"name":"ids","in":"query"},{"schema":{"type":"string"},"required":true,"name":"X-API-Key","in":"header"}],"responses":{"204":{"description":"Deleted dataset rows -- success"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden -- read-only API key cannot perform writes"},"404":{"description":"Dataset row not found"},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]}}}}}}},"/datasets/{datasetId}/rows/{datasetRowId}/values/batch":{"put":{"security":[{"workspaceApiKey":[]}],"operationId":"editDatasetRowValues","summary":"Edit dataset row values","tags":["Datasets"],"description":"Edit dataset row values.","parameters":[{"schema":{},"required":true,"name":"datasetId","in":"path"},{"schema":{},"required":true,"name":"datasetRowId","in":"path"},{"schema":{"type":"string"},"required":true,"name":"X-API-Key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"operation":{"type":"string","enum":["INSERT"]},"datasetColumnId":{},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"string"},{"type":"object","properties":{"fileType":{"type":"string"},"fileName":{"type":"string"},"objectKey":{"type":"string"},"documentType":{"type":"string"},"country":{"type":"string"},"county":{"type":"string"},"city":{"type":"string"},"streetName":{"type":"string"},"postalCode":{"type":"string"}},"required":["fileType","fileName","objectKey"]},{"type":"object","additionalProperties":{"nullable":true}},{"nullable":true}]},"datasetColumnOptionId":{"anyOf":[{},{},{"nullable":true}]}},"required":["operation","datasetColumnId","value","datasetColumnOptionId"]},{"type":"object","properties":{"operation":{"type":"string","enum":["UPDATE"]},"datasetRowValueId":{},"datasetColumnId":{},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"string"},{"type":"object","properties":{"fileType":{"type":"string"},"fileName":{"type":"string"},"objectKey":{"type":"string"},"documentType":{"type":"string"},"country":{"type":"string"},"county":{"type":"string"},"city":{"type":"string"},"streetName":{"type":"string"},"postalCode":{"type":"string"}},"required":["fileType","fileName","objectKey"]},{"type":"object","additionalProperties":{"nullable":true}},{"nullable":true}]},"datasetColumnOptionId":{"anyOf":[{},{},{"nullable":true}]}},"required":["operation","datasetRowValueId","datasetColumnId"]},{"type":"object","properties":{"operation":{"type":"string","enum":["DELETE"]},"datasetRowValueId":{}},"required":["operation","datasetRowValueId"]}]},"maxItems":100}},"required":["items"]}}}},"responses":{"200":{"description":"Edited dataset row values -- success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"string"},{"type":"object","properties":{"fileType":{"type":"string"},"fileName":{"type":"string"},"objectKey":{"type":"string"},"documentType":{"type":"string"},"country":{"type":"string"},"county":{"type":"string"},"city":{"type":"string"},"streetName":{"type":"string"},"postalCode":{"type":"string"}},"required":["fileType","fileName","objectKey"]},{"type":"object","additionalProperties":{"nullable":true}},{"nullable":true}]},"datasetRowId":{},"datasetColumnId":{},"datasetColumnOptionId":{"anyOf":[{},{},{"nullable":true}]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","value","datasetRowId","datasetColumnId","datasetColumnOptionId","createdAt","updatedAt"]}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden -- read-only API key cannot perform writes"},"404":{"description":"Dataset not found"},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]}}}}}}},"/datasets":{"get":{"security":[{"workspaceApiKey":[]}],"operationId":"listDatasets","summary":"List datasets","tags":["Datasets"],"description":"List all datasets in the current workspace","parameters":[{"schema":{"type":"string"},"required":true,"name":"X-API-Key","in":"header"}],"responses":{"200":{"description":"List of datasets -- success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{},"name":{"type":"string"},"datasetFolderId":{"nullable":true},"datasetFolderName":{"type":"string","nullable":true}},"required":["id","name","datasetFolderId","datasetFolderName"]}}}}},"401":{"description":"Unauthorized"},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]}}}}}}},"/datasets/{datasetId}":{"get":{"security":[{"workspaceApiKey":[]}],"operationId":"retrieveDatasetDetails","summary":"Retrieve dataset details","tags":["Datasets"],"description":"Retrieve details of a specific dataset by its ID","parameters":[{"schema":{},"required":true,"name":"datasetId","in":"path"},{"schema":{"type":"string"},"required":true,"name":"X-API-Key","in":"header"}],"responses":{"200":{"description":"Dataset details retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{},"organizationId":{"type":"string","nullable":true},"workspaceId":{"type":"string","nullable":true},"name":{"type":"string"},"description":{"type":"string","nullable":true},"managedBy":{"type":"string","enum":["COMPILOT","WORKSPACE","ORGANIZATION"]},"entityType":{"type":"string","enum":["INDIVIDUALS","COMPANIES","TRANSACTIONS","GENERIC"]},"datasetFolderId":{"nullable":true},"isMatrix":{"type":"boolean"},"matrixKeyColumnId":{"type":"string","nullable":true},"matrixKeyColumnIds":{"type":"array","nullable":true,"items":{"type":"string"}},"matrixValueColumnId":{"type":"string","nullable":true},"entitySyncEnabled":{"type":"boolean"},"entitySyncType":{"type":"string","nullable":true,"enum":["INDIVIDUALS","COMPANIES","TRANSACTIONS","GENERIC"]},"entitySyncExternalIdColumnId":{"type":"string","nullable":true},"entitySyncRiskColumnId":{"type":"string","nullable":true},"entitySyncStatusColumnId":{"type":"string","nullable":true},"entitySyncWalletColumnId":{"type":"string","nullable":true},"entitySyncNameColumnId":{"type":"string","nullable":true},"entitySyncCountryColumnId":{"type":"string","nullable":true},"lockMode":{"type":"string","enum":["EDITABLE","LOCKED_SOURCE","LINKED_INSTANCE"]},"originBlueprintId":{"type":"string","nullable":true},"bitemporalMode":{"type":"boolean"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"columns":{"type":"array","items":{"type":"object","properties":{"id":{},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"object","properties":{"id":{},"type":{"type":"string","enum":["TEXT","NUMBER","MULTI_SELECT","SINGLE_SELECT","RELATION","BOOLEAN","DATE","FILE_UPLOAD","NUMBER_RANGE","JSON","PERSON","LOOKUP","WALLET_ADDRESS","URL","TRANSACTION_PARTY","FORMULA"]},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","type","name","createdAt","updatedAt"]},"options":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{},{}]},"label":{"type":"string"}},"required":["id","label"]}}},"required":["id","name","createdAt","updatedAt","type","options"]}}},"required":["id","organizationId","workspaceId","name","description","managedBy","entityType","datasetFolderId","createdBy","updatedBy","createdAt","updatedAt","columns"]}}}},"401":{"description":"Unauthorized"},"404":{"description":"Dataset not found"},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]}}}}}}},"/datasets/{datasetId}/row-entities":{"get":{"security":[{"workspaceApiKey":[]}],"operationId":"listEntityDatasetRows","summary":"List dataset rows","tags":["Datasets"],"description":"List all rows of a specific dataset","parameters":[{"schema":{},"required":true,"name":"datasetId","in":"path"},{"schema":{"type":"number","nullable":true,"default":10},"required":false,"name":"limit","in":"query"},{"schema":{"type":"number","nullable":true,"default":0},"required":false,"name":"currentPage","in":"query"},{"schema":{"type":"array","items":{"type":"string"}},"required":false,"name":"entityIds","in":"query"},{"schema":{"type":"string"},"required":true,"name":"X-API-Key","in":"header"}],"responses":{"200":{"description":"List of dataset rows retrieved successfully","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{},"entityId":{"type":"string"}},"required":["id","entityId"]}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Dataset not found"},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]}}}}}}},"/datasets/{datasetId}/rows/{datasetRowId}":{"get":{"security":[{"workspaceApiKey":[]}],"operationId":"retrieveDatasetRowDetails","summary":"Retrieve dataset row details","tags":["Datasets"],"description":"Retrieve details of a specific dataset row by its ID","parameters":[{"schema":{},"required":true,"name":"datasetId","in":"path"},{"schema":{},"required":true,"name":"datasetRowId","in":"path"},{"schema":{"type":"string"},"required":true,"name":"X-API-Key","in":"header"}],"responses":{"200":{"description":"Dataset row details retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{},"values":{"type":"array","items":{"type":"object","properties":{"id":{},"datasetColumnId":{},"datasetColumnName":{"type":"string"},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"string"},{"type":"object","properties":{"fileType":{"type":"string"},"fileName":{"type":"string"},"objectKey":{"type":"string"},"documentType":{"type":"string"},"country":{"type":"string"},"county":{"type":"string"},"city":{"type":"string"},"streetName":{"type":"string"},"postalCode":{"type":"string"}},"required":["fileType","fileName","objectKey"]},{"type":"object","additionalProperties":{"nullable":true}},{"nullable":true}]},"columnOption":{"type":"object","nullable":true,"properties":{"id":{},"label":{"type":"string"}},"required":["id","label"]}},"required":["id","datasetColumnId","datasetColumnName","value","columnOption"]}}},"required":["id","values"]}}}},"401":{"description":"Unauthorized"},"404":{"description":"Dataset row not found"},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]}}}}}}},"/datasets/{datasetId}/rows/{datasetRowId}/files":{"post":{"security":[{"workspaceApiKey":[]}],"operationId":"storeDatasetFiles","summary":"Store dataset files","tags":["Datasets"],"description":"Store files for a specific dataset row","parameters":[{"schema":{},"required":true,"name":"datasetId","in":"path"},{"schema":{},"required":true,"name":"datasetRowId","in":"path"},{"schema":{"type":"string"},"required":true,"name":"X-API-Key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"datasetColumnId":{},"externalFileId":{"type":"string"},"fileType":{"type":"string"},"fileName":{"type":"string"}},"required":["datasetColumnId","fileType","fileName"]}}},"required":["files"]}}}},"responses":{"201":{"description":"Files stored successfully","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"datasetRowValueId":{},"externalFileId":{"type":"string"},"uploadUrl":{"type":"string"},"fileType":{"type":"string"},"fileName":{"type":"string"},"requiredUploadHeaders":{"type":"object","additionalProperties":{"type":"string"}}},"required":["datasetRowValueId","uploadUrl","fileType","fileName"]}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden -- read-only API key cannot perform writes"},"404":{"description":"Dataset or dataset row not found"},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]}}}}}}},"/workflows-engine/sig-gating":{"get":{"operationId":"listSigGatingWorkflows","security":[{"workspaceApiKey":[]}],"tags":["Sig Gating Workflows API"],"summary":"List sig-gating workflows","description":"Returns every sig-gating workflow configured for the organization and workspace resolved from the request's workspace API key. Each entry is the full workflow record (id, name, steps, and metadata); only workflows of type `SigGating` are returned. Responds 401 when the API key does not resolve to an organization and workspace.","responses":{"200":{"description":"List sig-gating workflows -- success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"type":{"type":"string","enum":["KYC","KYB","KYT","CustomerScreening","ZKP","TFHE","SigGating","DATASET_FORM"]},"workspaceId":{"type":"string"},"organizationId":{"type":"string"},"displayName":{"type":"string"},"valid":{"type":"boolean"},"reasons":{"type":"array","nullable":true,"items":{"type":"string","enum":["identity-widget-configuration-required","wallet-screening-step-required","rules-engine-step-required","duplicate-detection-step-required","fraud-detection-step-required","aml-screening-step-required","identity-verification-step-required","contract-allowlist-step-required","company-verification-step-required","transaction-creation-step-required","transaction-screening-step-required","customer-screening-creation-step-required","data-sharing-step-required","travel-rule-step-required","wallet-monitoring-step-required","wallet-screening-step-not-allowed","rules-engine-step-not-allowed","duplicate-detection-step-not-allowed","fraud-detection-step-not-allowed","aml-screening-step-not-allowed","identity-verification-step-not-allowed","contract-allowlist-step-not-allowed","company-verification-step-not-allowed","transaction-creation-step-not-allowed","transaction-screening-step-not-allowed","customer-screening-creation-step-not-allowed","data-sharing-step-not-allowed","travel-rule-step-not-allowed","wallet-monitoring-step-not-allowed","wallet-screening-step-invalid","rules-engine-step-invalid","duplicate-detection-step-invalid","fraud-detection-step-invalid","aml-screening-step-invalid","identity-verification-step-invalid","contract-allowlist-step-invalid","company-verification-step-invalid","transaction-creation-step-invalid","transaction-screening-step-invalid","customer-screening-creation-step-invalid","data-sharing-step-invalid","travel-rule-step-invalid","wallet-monitoring-step-invalid"]}},"verificationMode":{"type":"string","enum":["sandbox","full_verification"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"workflowSteps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["identity-verification","company-verification","duplicate-detection","aml-screening","wallet-screening","fraud-detection","contract-allowlist","rules-engine","transaction-creation","transaction-screening","customer-screening-creation","data-sharing","travel-rule","wallet-monitoring"]},"valid":{"type":"boolean"},"provider":{"type":"string","nullable":true,"enum":["nexeraIdSSID","nexeraIdKYB","synaps","ondato","complyAdvantage","big","scorechain","merkleScience","chainalysis","trmLabs","crystal","notabene","ipQualityScore","integratedComplyAdvantage","integratedScorechain","integratedIpqualityscore","notabene","integratedWalletMonitoring","veriff","onfido","sumsubKYC","seon","geocomply","sumsubKYB","integratedWalletMonitoring"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","type","valid","createdAt","updatedAt"]}},"protocol":{"type":"string","enum":["web2","web3"]}},"required":["id","status","type","workspaceId","organizationId","displayName","valid","reasons","verificationMode","createdAt","updatedAt","workflowSteps","protocol"]}}}}},"401":{"description":"List sig-gating workflows -- failure","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]}}}}}},"post":{"operationId":"createSigGatingWorkflow","security":[{"workspaceApiKey":[]}],"tags":["Sig Gating Workflows API"],"summary":"Create sig-gating workflow","description":"Creates a new sig-gating workflow in the organization and workspace resolved from the request's workspace API key. The request body is the workflow definition minus its `type`, which is forced to `SigGating` server-side. Responds 201 with the created workflow, or 401 when the API key does not resolve to an organization and workspace.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","minLength":1,"maxLength":120}},"required":["displayName"]}}}},"responses":{"201":{"description":"Create workflow -- success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"type":{"type":"string","enum":["KYC","KYB","KYT","CustomerScreening","ZKP","TFHE","SigGating","DATASET_FORM"]},"workspaceId":{"type":"string"},"organizationId":{"type":"string"},"displayName":{"type":"string"},"valid":{"type":"boolean"},"reasons":{"type":"array","nullable":true,"items":{"type":"string","enum":["identity-widget-configuration-required","wallet-screening-step-required","rules-engine-step-required","duplicate-detection-step-required","fraud-detection-step-required","aml-screening-step-required","identity-verification-step-required","contract-allowlist-step-required","company-verification-step-required","transaction-creation-step-required","transaction-screening-step-required","customer-screening-creation-step-required","data-sharing-step-required","travel-rule-step-required","wallet-monitoring-step-required","wallet-screening-step-not-allowed","rules-engine-step-not-allowed","duplicate-detection-step-not-allowed","fraud-detection-step-not-allowed","aml-screening-step-not-allowed","identity-verification-step-not-allowed","contract-allowlist-step-not-allowed","company-verification-step-not-allowed","transaction-creation-step-not-allowed","transaction-screening-step-not-allowed","customer-screening-creation-step-not-allowed","data-sharing-step-not-allowed","travel-rule-step-not-allowed","wallet-monitoring-step-not-allowed","wallet-screening-step-invalid","rules-engine-step-invalid","duplicate-detection-step-invalid","fraud-detection-step-invalid","aml-screening-step-invalid","identity-verification-step-invalid","contract-allowlist-step-invalid","company-verification-step-invalid","transaction-creation-step-invalid","transaction-screening-step-invalid","customer-screening-creation-step-invalid","data-sharing-step-invalid","travel-rule-step-invalid","wallet-monitoring-step-invalid"]}},"verificationMode":{"type":"string","enum":["sandbox","full_verification"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"workflowSteps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["identity-verification","company-verification","duplicate-detection","aml-screening","wallet-screening","fraud-detection","contract-allowlist","rules-engine","transaction-creation","transaction-screening","customer-screening-creation","data-sharing","travel-rule","wallet-monitoring"]},"valid":{"type":"boolean"},"provider":{"type":"string","nullable":true,"enum":["nexeraIdSSID","nexeraIdKYB","synaps","ondato","complyAdvantage","big","scorechain","merkleScience","chainalysis","trmLabs","crystal","notabene","ipQualityScore","integratedComplyAdvantage","integratedScorechain","integratedIpqualityscore","notabene","integratedWalletMonitoring","veriff","onfido","sumsubKYC","seon","geocomply","sumsubKYB","integratedWalletMonitoring"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","type","valid","createdAt","updatedAt"]}},"protocol":{"type":"string","enum":["web2","web3"]}},"required":["id","status","type","workspaceId","organizationId","displayName","valid","reasons","verificationMode","createdAt","updatedAt","workflowSteps","protocol"]}}}},"401":{"description":"Create workflow -- failure","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]}}}}}}},"/workflows-engine/sig-gating/{id}":{"get":{"operationId":"getSigGatingWorkflow","security":[{"workspaceApiKey":[]}],"tags":["Sig Gating Workflows API"],"summary":"Get sig-gating workflow","description":"Fetches a single sig-gating workflow by its UUID within the workspace resolved from the request's workspace API key, returning the full workflow record. Responds 404 when no workflow with that id exists in the workspace, or 401 when the API key does not resolve to an organization and workspace.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Get sig-gating workflow -- success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"type":{"type":"string","enum":["KYC","KYB","KYT","CustomerScreening","ZKP","TFHE","SigGating","DATASET_FORM"]},"workspaceId":{"type":"string"},"organizationId":{"type":"string"},"displayName":{"type":"string"},"valid":{"type":"boolean"},"reasons":{"type":"array","nullable":true,"items":{"type":"string","enum":["identity-widget-configuration-required","wallet-screening-step-required","rules-engine-step-required","duplicate-detection-step-required","fraud-detection-step-required","aml-screening-step-required","identity-verification-step-required","contract-allowlist-step-required","company-verification-step-required","transaction-creation-step-required","transaction-screening-step-required","customer-screening-creation-step-required","data-sharing-step-required","travel-rule-step-required","wallet-monitoring-step-required","wallet-screening-step-not-allowed","rules-engine-step-not-allowed","duplicate-detection-step-not-allowed","fraud-detection-step-not-allowed","aml-screening-step-not-allowed","identity-verification-step-not-allowed","contract-allowlist-step-not-allowed","company-verification-step-not-allowed","transaction-creation-step-not-allowed","transaction-screening-step-not-allowed","customer-screening-creation-step-not-allowed","data-sharing-step-not-allowed","travel-rule-step-not-allowed","wallet-monitoring-step-not-allowed","wallet-screening-step-invalid","rules-engine-step-invalid","duplicate-detection-step-invalid","fraud-detection-step-invalid","aml-screening-step-invalid","identity-verification-step-invalid","contract-allowlist-step-invalid","company-verification-step-invalid","transaction-creation-step-invalid","transaction-screening-step-invalid","customer-screening-creation-step-invalid","data-sharing-step-invalid","travel-rule-step-invalid","wallet-monitoring-step-invalid"]}},"verificationMode":{"type":"string","enum":["sandbox","full_verification"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"workflowSteps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["identity-verification","company-verification","duplicate-detection","aml-screening","wallet-screening","fraud-detection","contract-allowlist","rules-engine","transaction-creation","transaction-screening","customer-screening-creation","data-sharing","travel-rule","wallet-monitoring"]},"valid":{"type":"boolean"},"provider":{"type":"string","nullable":true,"enum":["nexeraIdSSID","nexeraIdKYB","synaps","ondato","complyAdvantage","big","scorechain","merkleScience","chainalysis","trmLabs","crystal","notabene","ipQualityScore","integratedComplyAdvantage","integratedScorechain","integratedIpqualityscore","notabene","integratedWalletMonitoring","veriff","onfido","sumsubKYC","seon","geocomply","sumsubKYB","integratedWalletMonitoring"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","type","valid","createdAt","updatedAt"]}},"protocol":{"type":"string","enum":["web2","web3"]}},"required":["id","status","type","workspaceId","organizationId","displayName","valid","reasons","verificationMode","createdAt","updatedAt","workflowSteps","protocol"]}}}},"401":{"description":"Get sig-gating workflow -- failure","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"Sig-gating workflow not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]}}}}}},"patch":{"operationId":"updateSigGatingWorkflow","security":[{"workspaceApiKey":[]}],"tags":["Sig Gating Workflows API"],"summary":"Update sig-gating workflow","description":"Updates the sig-gating workflow identified by the path `id` within the workspace resolved from the request's workspace API key. The request body carries the mutable workflow fields; `type` cannot be changed and is omitted. Responds 200 with the updated workflow, 404 when no such workflow exists, or 401 when the API key does not resolve to an organization and workspace.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"displayName":{"type":"string","minLength":1,"maxLength":120},"verificationMode":{"type":"string","enum":["sandbox","full_verification"]},"valid":{"type":"boolean"},"protocol":{"type":"string","enum":["web2","web3"]}}}}}},"responses":{"200":{"description":"Update workflow -- success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"type":{"type":"string","enum":["KYC","KYB","KYT","CustomerScreening","ZKP","TFHE","SigGating","DATASET_FORM"]},"workspaceId":{"type":"string"},"organizationId":{"type":"string"},"displayName":{"type":"string"},"valid":{"type":"boolean"},"reasons":{"type":"array","nullable":true,"items":{"type":"string","enum":["identity-widget-configuration-required","wallet-screening-step-required","rules-engine-step-required","duplicate-detection-step-required","fraud-detection-step-required","aml-screening-step-required","identity-verification-step-required","contract-allowlist-step-required","company-verification-step-required","transaction-creation-step-required","transaction-screening-step-required","customer-screening-creation-step-required","data-sharing-step-required","travel-rule-step-required","wallet-monitoring-step-required","wallet-screening-step-not-allowed","rules-engine-step-not-allowed","duplicate-detection-step-not-allowed","fraud-detection-step-not-allowed","aml-screening-step-not-allowed","identity-verification-step-not-allowed","contract-allowlist-step-not-allowed","company-verification-step-not-allowed","transaction-creation-step-not-allowed","transaction-screening-step-not-allowed","customer-screening-creation-step-not-allowed","data-sharing-step-not-allowed","travel-rule-step-not-allowed","wallet-monitoring-step-not-allowed","wallet-screening-step-invalid","rules-engine-step-invalid","duplicate-detection-step-invalid","fraud-detection-step-invalid","aml-screening-step-invalid","identity-verification-step-invalid","contract-allowlist-step-invalid","company-verification-step-invalid","transaction-creation-step-invalid","transaction-screening-step-invalid","customer-screening-creation-step-invalid","data-sharing-step-invalid","travel-rule-step-invalid","wallet-monitoring-step-invalid"]}},"verificationMode":{"type":"string","enum":["sandbox","full_verification"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"workflowSteps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["identity-verification","company-verification","duplicate-detection","aml-screening","wallet-screening","fraud-detection","contract-allowlist","rules-engine","transaction-creation","transaction-screening","customer-screening-creation","data-sharing","travel-rule","wallet-monitoring"]},"valid":{"type":"boolean"},"provider":{"type":"string","nullable":true,"enum":["nexeraIdSSID","nexeraIdKYB","synaps","ondato","complyAdvantage","big","scorechain","merkleScience","chainalysis","trmLabs","crystal","notabene","ipQualityScore","integratedComplyAdvantage","integratedScorechain","integratedIpqualityscore","notabene","integratedWalletMonitoring","veriff","onfido","sumsubKYC","seon","geocomply","sumsubKYB","integratedWalletMonitoring"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","type","valid","createdAt","updatedAt"]}},"protocol":{"type":"string","enum":["web2","web3"]}},"required":["id","status","type","workspaceId","organizationId","displayName","valid","reasons","verificationMode","createdAt","updatedAt","workflowSteps","protocol"]}}}},"401":{"description":"Update workflow -- failure","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"Update workflow -- failure","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]}}}}}},"delete":{"operationId":"deleteSigGatingWorkflow","security":[{"workspaceApiKey":[]}],"tags":["Sig Gating Workflows API"],"summary":"Delete sig-gating workflow","description":"Deletes the sig-gating workflow identified by the path `id` within the workspace resolved from the request's workspace API key. Responds 200 with the deleted workflow, 400 when the target workflow is not a `SigGating` workflow (including when no matching workflow exists), or 401 when the API key does not resolve to an organization and workspace.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Delete workflow -- success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"type":{"type":"string","enum":["KYC","KYB","KYT","CustomerScreening","ZKP","TFHE","SigGating","DATASET_FORM"]},"workspaceId":{"type":"string"},"organizationId":{"type":"string"},"displayName":{"type":"string"},"valid":{"type":"boolean"},"reasons":{"type":"array","nullable":true,"items":{"type":"string","enum":["identity-widget-configuration-required","wallet-screening-step-required","rules-engine-step-required","duplicate-detection-step-required","fraud-detection-step-required","aml-screening-step-required","identity-verification-step-required","contract-allowlist-step-required","company-verification-step-required","transaction-creation-step-required","transaction-screening-step-required","customer-screening-creation-step-required","data-sharing-step-required","travel-rule-step-required","wallet-monitoring-step-required","wallet-screening-step-not-allowed","rules-engine-step-not-allowed","duplicate-detection-step-not-allowed","fraud-detection-step-not-allowed","aml-screening-step-not-allowed","identity-verification-step-not-allowed","contract-allowlist-step-not-allowed","company-verification-step-not-allowed","transaction-creation-step-not-allowed","transaction-screening-step-not-allowed","customer-screening-creation-step-not-allowed","data-sharing-step-not-allowed","travel-rule-step-not-allowed","wallet-monitoring-step-not-allowed","wallet-screening-step-invalid","rules-engine-step-invalid","duplicate-detection-step-invalid","fraud-detection-step-invalid","aml-screening-step-invalid","identity-verification-step-invalid","contract-allowlist-step-invalid","company-verification-step-invalid","transaction-creation-step-invalid","transaction-screening-step-invalid","customer-screening-creation-step-invalid","data-sharing-step-invalid","travel-rule-step-invalid","wallet-monitoring-step-invalid"]}},"verificationMode":{"type":"string","enum":["sandbox","full_verification"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"workflowSteps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["identity-verification","company-verification","duplicate-detection","aml-screening","wallet-screening","fraud-detection","contract-allowlist","rules-engine","transaction-creation","transaction-screening","customer-screening-creation","data-sharing","travel-rule","wallet-monitoring"]},"valid":{"type":"boolean"},"provider":{"type":"string","nullable":true,"enum":["nexeraIdSSID","nexeraIdKYB","synaps","ondato","complyAdvantage","big","scorechain","merkleScience","chainalysis","trmLabs","crystal","notabene","ipQualityScore","integratedComplyAdvantage","integratedScorechain","integratedIpqualityscore","notabene","integratedWalletMonitoring","veriff","onfido","sumsubKYC","seon","geocomply","sumsubKYB","integratedWalletMonitoring"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","type","valid","createdAt","updatedAt"]}},"protocol":{"type":"string","enum":["web2","web3"]}},"required":["id","status","type","workspaceId","organizationId","displayName","valid","reasons","verificationMode","createdAt","updatedAt","workflowSteps","protocol"]}}}},"400":{"description":"Delete workflow -- failure","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]}}}}}}},"/workflows-engine/sig-gating/{workflowId}/rules-engine":{"post":{"operationId":"createRulesEngineSigGatingStep","security":[{"workspaceApiKey":[]}],"tags":["Sig Gating Workflows API"],"summary":"Create sig-gating rules engine step","description":"Adds a rules-engine step to the sig-gating workflow identified by the path `workflowId`, wiring the supplied `scenarioIds` into it. Returns the created step together with its attached scenarios. Responds 400 on invalid input (e.g. an unknown workflow or scenario id), or 401 when the API key does not resolve to an organization and workspace.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"workflowId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"scenarioIds":{"type":"array","items":{}}},"required":["scenarioIds"]}}}},"responses":{"200":{"description":"Create rules engine step -- success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"workflowStepId":{"type":"string","format":"uuid"},"valid":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"scenarios":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalScenarioId":{"type":"string"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","externalScenarioId","createdAt","updatedAt"]}}},"required":["id","workflowStepId","valid","createdAt","updatedAt","scenarios"]}}}},"400":{"description":"Create rules engine step -- failure","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]}}}}}},"get":{"operationId":"listSigGatingRulesEngineSteps","security":[{"workspaceApiKey":[]}],"tags":["Sig Gating Workflows API"],"summary":"List sig-gating rules engine steps","description":"Returns the rules-engine steps configured on the sig-gating workflow identified by the path `workflowId`, each with its attached scenarios, for the workspace resolved from the request's workspace API key. Responds 400 on invalid input, or 401 when the API key does not resolve to an organization and workspace.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"workflowId","in":"path"}],"responses":{"200":{"description":"List rules engine step with scenarios -- success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"workflowStepId":{"type":"string","format":"uuid"},"valid":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"scenarios":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalScenarioId":{"type":"string"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","externalScenarioId","createdAt","updatedAt"]}}},"required":["id","workflowStepId","valid","createdAt","updatedAt","scenarios"]}}}}},"400":{"description":"List rules engine step with scenarios -- failure","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]}}}}}}},"/workflows-engine/sig-gating/{workflowId}/rules-engine/{rulesEngineStepId}/scenarios/{scenarioId}":{"delete":{"operationId":"deleteRulesEngineSigGatingScenario","security":[{"workspaceApiKey":[]}],"tags":["Sig Gating Workflows API"],"summary":"Delete sig-gating rules engine scenario","description":"Detaches a single scenario (`scenarioId`, accepted as either an external or internal scenario id) from the rules-engine step `rulesEngineStepId` on the sig-gating workflow `workflowId`, within the workspace resolved from the request's workspace API key. Responds 200 on success, 400 on invalid input, or 401 when the API key does not resolve to an organization and workspace.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"workflowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"rulesEngineStepId","in":"path"},{"schema":{"anyOf":[{},{"type":"string","format":"uuid"}]},"required":true,"name":"scenarioId","in":"path"}],"responses":{"200":{"description":"Delete rules engine scenario -- success"},"400":{"description":"Delete rules engine scenario -- failure","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]}}}}}}},"/workflows-engine/sig-gating/{workflowId}/rules-engine/{rulesEngineStepId}/scenarios":{"post":{"operationId":"createSigGatingRulesEngineScenarios","security":[{"workspaceApiKey":[]}],"tags":["Sig Gating Workflows API"],"summary":"Add sig-gating rules engine scenarios","description":"Attaches the supplied `scenarioIds` to the rules-engine step identified by `rulesEngineStepId` on the sig-gating workflow `workflowId`, within the workspace resolved from the request's workspace API key. Returns the resulting rules-engine scenario links. Responds 400 on invalid input, or 401 when the API key does not resolve to an organization and workspace.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"workflowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"rulesEngineStepId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"scenarioIds":{"type":"array","items":{}}},"required":["scenarioIds"]}}}},"responses":{"200":{"description":"Add rules engine scenario -- success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"rulesEngineStepId":{"type":"string","format":"uuid"},"externalScenarioId":{"type":"string"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","rulesEngineStepId","externalScenarioId","createdAt","updatedAt"]}}}}},"400":{"description":"Add rules engine scenario -- failure","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]}}}}}}},"/rules-engine/scenarios":{"post":{"operationId":"createScenario","security":[{"workspaceApiKey":[]}],"tags":["Sig Gating Workflows API"],"summary":"Create a scenario","description":"Creates a signature-gating scenario for the workspace resolved from the request's API key. The scenario is always created as type BlockchainPolicies and mode EXTERNAL, so the request body omits both `type` and `mode`. The body carries the scenario name, an optional description, its primary evaluation method (queries and query groups) and its actions. Returns 401 when the API key does not resolve to an organization and workspace.","parameters":[{"schema":{"type":"string"},"required":true,"name":"X-API-Key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","nullable":true},"primaryEvaluationMethod":{"type":"object","properties":{"operator":{"type":"string","enum":["AND","OR"]},"queries":{"type":"array","items":{"type":"object","properties":{"queryId":{"description":"Unique ID for the query"},"id":{"description":"Unique ID for the query"},"requestId":{"type":"number","nullable":true,"description":"Request ID for ZKPs"},"attribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"secondaryAttribute":{"type":"object","nullable":true,"properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"number"}},{"nullable":true}]},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"displayMode":{"type":"string","nullable":true,"enum":["amount","percentage"]},"timeframe":{"type":"string","nullable":true,"enum":["daily","weekly","monthly","yearly"]},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","nullable":true,"enum":["ACTIVE_USERS_ADDRESSES"]}},"required":["attribute","operator"]}},"queryGroups":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Unique ID for the query group"},"operator":{"type":"string","enum":["AND","OR"]},"queries":{"type":"array","items":{"type":"object","properties":{"queryId":{"description":"Unique ID for the query"},"id":{"description":"Unique ID for the query"},"requestId":{"type":"number","nullable":true,"description":"Request ID for ZKPs"},"attribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"secondaryAttribute":{"type":"object","nullable":true,"properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"number"}},{"nullable":true}]},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"displayMode":{"type":"string","nullable":true,"enum":["amount","percentage"]},"timeframe":{"type":"string","nullable":true,"enum":["daily","weekly","monthly","yearly"]},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","nullable":true,"enum":["ACTIVE_USERS_ADDRESSES"]}},"required":["attribute","operator"]}}},"required":["operator","queries"]}}},"required":["operator","queries","queryGroups"]},"actions":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["SET_CUSTOMER_RISK_LEVEL","SET_CUSTOMER_STATUS","SET_ALERT_RISK_LEVEL","SET_TRANSACTION_RISK_LEVEL","SET_TRANSACTION_STATUS","ASSIGN_COMPLIANCE_OFFICER","CREATE_ALERT","ASSIGN_TAG","BLOCK_ON_CHAIN_TRANSACTION","SET_DATASET_COLUMN_VALUE"]},"trigger":{"type":"string","enum":["ON_TRUE","ON_FALSE","ALWAYS"]},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"value":{"type":"string"}},"required":["type","trigger","status","value"]}},"entityType":{"type":"string","enum":["individual","company","transaction"]}},"required":["name","primaryEvaluationMethod","actions"]},"example":{"name":"US resident gating policy","description":"Approves signature-gated requests from US-resident customers.","primaryEvaluationMethod":{"operator":"AND","queries":[{"attribute":{"version":"v1","schema":"Customer","path":"Customer/identityData/nationality"},"operator":"$eq","value":"US"}],"queryGroups":[]},"actions":[{"type":"SET_CUSTOMER_STATUS","trigger":"ON_TRUE","status":"ENABLED","value":"Approved"}],"entityType":"individual"}}}},"responses":{"201":{"description":"Create scenario -- success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{},"name":{"type":"string"},"type":{"type":"string","enum":["PrivacyPreservingMonitoring","IndividualMonitoring","DatasetMonitoring","TransactionMonitoring","TFHE","BlockchainPolicies","CompanyMonitoring"]},"description":{"type":"string","nullable":true},"organizationId":{"type":"string"},"workspaceId":{"type":"string"},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"entityType":{"type":"string","nullable":true,"enum":["individual","company","transaction"]},"cmsScenarioId":{"type":"string","nullable":true},"primaryEvaluationMethod":{"type":"object","nullable":true,"properties":{"id":{},"purpose":{"type":"string","enum":["TRIGGER","PRIMARY"]},"queryBlocksMergeOperator":{"type":"string","enum":["AND","OR"]},"queries":{"type":"array","items":{"type":"object","properties":{"id":{},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","nullable":true,"enum":["ACTIVE_USERS_ADDRESSES"]},"value":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"nullable":true},{"type":"array","items":{"type":"string"}},{"nullable":true}]},{"type":"array","items":{"type":"string"}},{"nullable":true}]},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"timeframe":{"type":"string","nullable":true,"enum":["daily","weekly","monthly","yearly"]},"attribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"secondaryAttribute":{"type":"object","nullable":true,"properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"options":{"type":"array","nullable":true,"items":{"type":"object","properties":{"title":{"type":"string"},"link":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]}},"required":["title","link"]}},"displayMode":{"type":"string","nullable":true,"enum":["amount","percentage"]},"secondaryLinks":{"type":"array","nullable":true,"items":{"type":"object","properties":{"title":{"type":"string"},"link":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]}},"required":["title","link"]}},"displayOrder":{"type":"number"},"cmsQueryId":{"type":"string","nullable":true},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"evaluationMethodId":{"nullable":true},"queryGroupId":{"nullable":true},"interpretDataAs":{"type":"string","nullable":true,"enum":["bigint","date","number","boolean","string","decimal","array"]},"interpretSecondaryDataAs":{"type":"string","nullable":true,"enum":["bigint","date","number","boolean","string","decimal","array"]}},"required":["id","datasetColumnId","sourceDatasetColumnId","specialDataSetType","operator","timeframe","attribute","secondaryAttribute","options","displayMode","secondaryLinks","displayOrder","cmsQueryId","createdAt","updatedAt","createdBy","updatedBy"]}},"queryGroups":{"type":"array","items":{"type":"object","description":"A query group with nested subGroups forming a recursive hierarchy.","title":"RecursiveQueryGroup","properties":{"id":{"type":"string","description":"Unique identifier of the query group"},"evaluationMethodId":{"type":"string","description":"Identifier for the evaluation method"},"operator":{"type":"string","description":"Logical operator applied in the group"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"queries":{"type":"array","description":"List of queries in this group","items":{"$ref":"#/components/schemas/QueriesOutput"}},"createdBy":{"type":"string","description":"ID of member who created the group"},"updatedBy":{"type":"string","description":"ID of member who last updated the group"},"parentGroupId":{"type":["string","null"],"nullable":true,"description":"Optional parent group ID"},"subGroups":{"type":"array","description":"Nested sub query groups","items":{"$ref":"#/components/schemas/RecursiveQueryGroup"}}},"required":["id","evaluationMethodId","operator","createdAt","updatedAt","queries","createdBy","updatedBy","subGroups"]}},"type":{"type":"string","enum":["fixed_risk_matrix","composable_rules_system"]},"scenarioId":{},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true}},"required":["id","purpose","queryBlocksMergeOperator","queries","queryGroups","type","scenarioId","status","createdBy","updatedBy","createdAt","updatedAt"]},"triggerEvaluationMethod":{"type":"object","nullable":true,"properties":{"id":{},"purpose":{"type":"string","enum":["TRIGGER","PRIMARY"]},"queryBlocksMergeOperator":{"type":"string","enum":["AND","OR"]},"queries":{"type":"array","items":{"type":"object","properties":{"id":{},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","nullable":true,"enum":["ACTIVE_USERS_ADDRESSES"]},"value":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"nullable":true},{"type":"array","items":{"type":"string"}},{"nullable":true}]},{"type":"array","items":{"type":"string"}},{"nullable":true}]},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"timeframe":{"type":"string","nullable":true,"enum":["daily","weekly","monthly","yearly"]},"attribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"secondaryAttribute":{"type":"object","nullable":true,"properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"options":{"type":"array","nullable":true,"items":{"type":"object","properties":{"title":{"type":"string"},"link":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]}},"required":["title","link"]}},"displayMode":{"type":"string","nullable":true,"enum":["amount","percentage"]},"secondaryLinks":{"type":"array","nullable":true,"items":{"type":"object","properties":{"title":{"type":"string"},"link":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]}},"required":["title","link"]}},"displayOrder":{"type":"number"},"cmsQueryId":{"type":"string","nullable":true},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"evaluationMethodId":{"nullable":true},"queryGroupId":{"nullable":true},"interpretDataAs":{"type":"string","nullable":true,"enum":["bigint","date","number","boolean","string","decimal","array"]},"interpretSecondaryDataAs":{"type":"string","nullable":true,"enum":["bigint","date","number","boolean","string","decimal","array"]}},"required":["id","datasetColumnId","sourceDatasetColumnId","specialDataSetType","operator","timeframe","attribute","secondaryAttribute","options","displayMode","secondaryLinks","displayOrder","cmsQueryId","createdAt","updatedAt","createdBy","updatedBy"]}},"queryGroups":{"type":"array","items":{"type":"object","description":"A query group with nested subGroups forming a recursive hierarchy.","title":"RecursiveQueryGroup","properties":{"id":{"type":"string","description":"Unique identifier of the query group"},"evaluationMethodId":{"type":"string","description":"Identifier for the evaluation method"},"operator":{"type":"string","description":"Logical operator applied in the group"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"queries":{"type":"array","description":"List of queries in this group","items":{"$ref":"#/components/schemas/QueriesOutput"}},"createdBy":{"type":"string","description":"ID of member who created the group"},"updatedBy":{"type":"string","description":"ID of member who last updated the group"},"parentGroupId":{"type":["string","null"],"nullable":true,"description":"Optional parent group ID"},"subGroups":{"type":"array","description":"Nested sub query groups","items":{"$ref":"#/components/schemas/RecursiveQueryGroup"}}},"required":["id","evaluationMethodId","operator","createdAt","updatedAt","queries","createdBy","updatedBy","subGroups"]}},"type":{"type":"string","enum":["fixed_risk_matrix","composable_rules_system"]},"scenarioId":{},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true}},"required":["id","purpose","queryBlocksMergeOperator","queries","queryGroups","type","scenarioId","status","createdBy","updatedBy","createdAt","updatedAt"]},"actions":{"type":"array","items":{"type":"object","properties":{"id":{},"scenarioId":{},"type":{"type":"string","enum":["SET_CUSTOMER_RISK_LEVEL","SET_CUSTOMER_STATUS","SET_ALERT_RISK_LEVEL","SET_TRANSACTION_RISK_LEVEL","SET_TRANSACTION_STATUS","ASSIGN_COMPLIANCE_OFFICER","CREATE_ALERT","ASSIGN_TAG","BLOCK_ON_CHAIN_TRANSACTION","SET_DATASET_COLUMN_VALUE"]},"value":{"type":"string"},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"trigger":{"type":"string","enum":["ON_TRUE","ON_FALSE","ALWAYS"]},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true}},"required":["id","scenarioId","type","value","status","trigger","createdAt","updatedAt"]}},"mode":{"type":"string","enum":["INTERNAL","EXTERNAL"]},"datasetId":{"nullable":true}},"required":["id","name","type","description","organizationId","workspaceId","createdAt","updatedAt","createdBy","updatedBy","entityType","cmsScenarioId","primaryEvaluationMethod","triggerEvaluationMethod","actions","mode","datasetId"]},"example":{"id":"scenario_a1b2c3d4e5f6","name":"US resident gating policy","type":"BlockchainPolicies","description":"Approves signature-gated requests from US-resident customers.","organizationId":"org_9f8e7d6c5b4a","workspaceId":"ws_3b2a1c4d5e6f","createdAt":"2026-03-14T09:30:00.000Z","updatedAt":"2026-03-14T09:30:00.000Z","createdBy":"api","updatedBy":"api","entityType":"individual","cmsScenarioId":null,"primaryEvaluationMethod":null,"triggerEvaluationMethod":null,"actions":[],"mode":"EXTERNAL","datasetId":null}}}},"400":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]},"example":{"message":"Organization or workspace not found","traceId":"trace_ab12cd34ef56"}}}},"401":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]},"example":{"message":"Organization or workspace not found","traceId":"trace_ab12cd34ef56"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]},"example":{"message":"Organization or workspace not found","traceId":"trace_ab12cd34ef56"}}}}}},"get":{"operationId":"listScenarios","security":[{"workspaceApiKey":[]}],"tags":["Sig Gating Workflows API"],"summary":"List scenarios","description":"Returns a paginated list of the EXTERNAL-mode scenarios belonging to the workspace resolved from the request's API key. `currentPage` is zero-based and `limit` defaults to 10. Returns 401 when the API key does not resolve to an organization and workspace.","parameters":[{"schema":{"type":"string","default":"0"},"required":false,"name":"currentPage","in":"query"},{"schema":{"type":"string","default":"10"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":true,"name":"X-API-Key","in":"header"}],"responses":{"200":{"description":"List scenarios -- success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{},"name":{"type":"string"},"type":{"type":"string","enum":["PrivacyPreservingMonitoring","IndividualMonitoring","DatasetMonitoring","TransactionMonitoring","TFHE","BlockchainPolicies","CompanyMonitoring"]},"description":{"type":"string","nullable":true},"organizationId":{"type":"string"},"workspaceId":{"type":"string"},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"entityType":{"type":"string","nullable":true,"enum":["individual","company","transaction"]},"cmsScenarioId":{"type":"string","nullable":true},"primaryEvaluationMethod":{"type":"object","nullable":true,"properties":{"id":{},"purpose":{"type":"string","enum":["TRIGGER","PRIMARY"]},"queryBlocksMergeOperator":{"type":"string","enum":["AND","OR"]},"queries":{"type":"array","items":{"type":"object","properties":{"id":{},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","nullable":true,"enum":["ACTIVE_USERS_ADDRESSES"]},"value":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"nullable":true},{"type":"array","items":{"type":"string"}},{"nullable":true}]},{"type":"array","items":{"type":"string"}},{"nullable":true}]},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"timeframe":{"type":"string","nullable":true,"enum":["daily","weekly","monthly","yearly"]},"attribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"secondaryAttribute":{"type":"object","nullable":true,"properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"options":{"type":"array","nullable":true,"items":{"type":"object","properties":{"title":{"type":"string"},"link":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]}},"required":["title","link"]}},"displayMode":{"type":"string","nullable":true,"enum":["amount","percentage"]},"secondaryLinks":{"type":"array","nullable":true,"items":{"type":"object","properties":{"title":{"type":"string"},"link":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]}},"required":["title","link"]}},"displayOrder":{"type":"number"},"cmsQueryId":{"type":"string","nullable":true},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"evaluationMethodId":{"nullable":true},"queryGroupId":{"nullable":true},"interpretDataAs":{"type":"string","nullable":true,"enum":["bigint","date","number","boolean","string","decimal","array"]},"interpretSecondaryDataAs":{"type":"string","nullable":true,"enum":["bigint","date","number","boolean","string","decimal","array"]}},"required":["id","datasetColumnId","sourceDatasetColumnId","specialDataSetType","operator","timeframe","attribute","secondaryAttribute","options","displayMode","secondaryLinks","displayOrder","cmsQueryId","createdAt","updatedAt","createdBy","updatedBy"]}},"queryGroups":{"type":"array","items":{"type":"object","description":"A query group with nested subGroups forming a recursive hierarchy.","title":"RecursiveQueryGroup","properties":{"id":{"type":"string","description":"Unique identifier of the query group"},"evaluationMethodId":{"type":"string","description":"Identifier for the evaluation method"},"operator":{"type":"string","description":"Logical operator applied in the group"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"queries":{"type":"array","description":"List of queries in this group","items":{"$ref":"#/components/schemas/QueriesOutput"}},"createdBy":{"type":"string","description":"ID of member who created the group"},"updatedBy":{"type":"string","description":"ID of member who last updated the group"},"parentGroupId":{"type":["string","null"],"nullable":true,"description":"Optional parent group ID"},"subGroups":{"type":"array","description":"Nested sub query groups","items":{"$ref":"#/components/schemas/RecursiveQueryGroup"}}},"required":["id","evaluationMethodId","operator","createdAt","updatedAt","queries","createdBy","updatedBy","subGroups"]}},"type":{"type":"string","enum":["fixed_risk_matrix","composable_rules_system"]},"scenarioId":{},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true}},"required":["id","purpose","queryBlocksMergeOperator","queries","queryGroups","type","scenarioId","status","createdBy","updatedBy","createdAt","updatedAt"]},"triggerEvaluationMethod":{"type":"object","nullable":true,"properties":{"id":{},"purpose":{"type":"string","enum":["TRIGGER","PRIMARY"]},"queryBlocksMergeOperator":{"type":"string","enum":["AND","OR"]},"queries":{"type":"array","items":{"type":"object","properties":{"id":{},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","nullable":true,"enum":["ACTIVE_USERS_ADDRESSES"]},"value":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"nullable":true},{"type":"array","items":{"type":"string"}},{"nullable":true}]},{"type":"array","items":{"type":"string"}},{"nullable":true}]},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"timeframe":{"type":"string","nullable":true,"enum":["daily","weekly","monthly","yearly"]},"attribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"secondaryAttribute":{"type":"object","nullable":true,"properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"options":{"type":"array","nullable":true,"items":{"type":"object","properties":{"title":{"type":"string"},"link":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]}},"required":["title","link"]}},"displayMode":{"type":"string","nullable":true,"enum":["amount","percentage"]},"secondaryLinks":{"type":"array","nullable":true,"items":{"type":"object","properties":{"title":{"type":"string"},"link":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]}},"required":["title","link"]}},"displayOrder":{"type":"number"},"cmsQueryId":{"type":"string","nullable":true},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"evaluationMethodId":{"nullable":true},"queryGroupId":{"nullable":true},"interpretDataAs":{"type":"string","nullable":true,"enum":["bigint","date","number","boolean","string","decimal","array"]},"interpretSecondaryDataAs":{"type":"string","nullable":true,"enum":["bigint","date","number","boolean","string","decimal","array"]}},"required":["id","datasetColumnId","sourceDatasetColumnId","specialDataSetType","operator","timeframe","attribute","secondaryAttribute","options","displayMode","secondaryLinks","displayOrder","cmsQueryId","createdAt","updatedAt","createdBy","updatedBy"]}},"queryGroups":{"type":"array","items":{"type":"object","description":"A query group with nested subGroups forming a recursive hierarchy.","title":"RecursiveQueryGroup","properties":{"id":{"type":"string","description":"Unique identifier of the query group"},"evaluationMethodId":{"type":"string","description":"Identifier for the evaluation method"},"operator":{"type":"string","description":"Logical operator applied in the group"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"queries":{"type":"array","description":"List of queries in this group","items":{"$ref":"#/components/schemas/QueriesOutput"}},"createdBy":{"type":"string","description":"ID of member who created the group"},"updatedBy":{"type":"string","description":"ID of member who last updated the group"},"parentGroupId":{"type":["string","null"],"nullable":true,"description":"Optional parent group ID"},"subGroups":{"type":"array","description":"Nested sub query groups","items":{"$ref":"#/components/schemas/RecursiveQueryGroup"}}},"required":["id","evaluationMethodId","operator","createdAt","updatedAt","queries","createdBy","updatedBy","subGroups"]}},"type":{"type":"string","enum":["fixed_risk_matrix","composable_rules_system"]},"scenarioId":{},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true}},"required":["id","purpose","queryBlocksMergeOperator","queries","queryGroups","type","scenarioId","status","createdBy","updatedBy","createdAt","updatedAt"]},"actions":{"type":"array","items":{"type":"object","properties":{"id":{},"scenarioId":{},"type":{"type":"string","enum":["SET_CUSTOMER_RISK_LEVEL","SET_CUSTOMER_STATUS","SET_ALERT_RISK_LEVEL","SET_TRANSACTION_RISK_LEVEL","SET_TRANSACTION_STATUS","ASSIGN_COMPLIANCE_OFFICER","CREATE_ALERT","ASSIGN_TAG","BLOCK_ON_CHAIN_TRANSACTION","SET_DATASET_COLUMN_VALUE"]},"value":{"type":"string"},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"trigger":{"type":"string","enum":["ON_TRUE","ON_FALSE","ALWAYS"]},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true}},"required":["id","scenarioId","type","value","status","trigger","createdAt","updatedAt"]}},"mode":{"type":"string","enum":["INTERNAL","EXTERNAL"]},"datasetId":{"nullable":true}},"required":["id","name","type","description","organizationId","workspaceId","createdAt","updatedAt","createdBy","updatedBy","entityType","cmsScenarioId","primaryEvaluationMethod","triggerEvaluationMethod","actions","mode","datasetId"]}},"totalCount":{"type":"number"}},"required":["data","totalCount"]},"example":{"data":[{"id":"scenario_a1b2c3d4e5f6","name":"US resident gating policy","type":"BlockchainPolicies","description":"Approves signature-gated requests from US-resident customers.","organizationId":"org_9f8e7d6c5b4a","workspaceId":"ws_3b2a1c4d5e6f","createdAt":"2026-03-14T09:30:00.000Z","updatedAt":"2026-03-14T09:30:00.000Z","createdBy":"api","updatedBy":"api","entityType":"individual","cmsScenarioId":null,"primaryEvaluationMethod":null,"triggerEvaluationMethod":null,"actions":[],"mode":"EXTERNAL","datasetId":null}],"totalCount":1}}}},"401":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]},"example":{"message":"Organization or workspace not found","traceId":"trace_ab12cd34ef56"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]},"example":{"message":"Organization or workspace not found","traceId":"trace_ab12cd34ef56"}}}}}}},"/rules-engine/scenarios/{id}":{"get":{"operationId":"getScenario","security":[{"workspaceApiKey":[]}],"tags":["Sig Gating Workflows API"],"summary":"Get a scenario by ID","description":"Fetches a single scenario by ID within the workspace resolved from the request's API key, hydrated with its evaluation methods and actions. Returns 404 when no scenario with that ID exists in the workspace, or 401 when the API key does not resolve to an organization and workspace.","parameters":[{"schema":{},"required":true,"name":"id","in":"path"},{"schema":{"type":"string"},"required":true,"name":"X-API-Key","in":"header"}],"responses":{"200":{"description":"Get scenario -- success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{},"name":{"type":"string"},"type":{"type":"string","enum":["PrivacyPreservingMonitoring","IndividualMonitoring","DatasetMonitoring","TransactionMonitoring","TFHE","BlockchainPolicies","CompanyMonitoring"]},"description":{"type":"string","nullable":true},"organizationId":{"type":"string"},"workspaceId":{"type":"string"},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"entityType":{"type":"string","nullable":true,"enum":["individual","company","transaction"]},"cmsScenarioId":{"type":"string","nullable":true},"primaryEvaluationMethod":{"type":"object","nullable":true,"properties":{"id":{},"purpose":{"type":"string","enum":["TRIGGER","PRIMARY"]},"queryBlocksMergeOperator":{"type":"string","enum":["AND","OR"]},"queries":{"type":"array","items":{"type":"object","properties":{"id":{},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","nullable":true,"enum":["ACTIVE_USERS_ADDRESSES"]},"value":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"nullable":true},{"type":"array","items":{"type":"string"}},{"nullable":true}]},{"type":"array","items":{"type":"string"}},{"nullable":true}]},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"timeframe":{"type":"string","nullable":true,"enum":["daily","weekly","monthly","yearly"]},"attribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"secondaryAttribute":{"type":"object","nullable":true,"properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"options":{"type":"array","nullable":true,"items":{"type":"object","properties":{"title":{"type":"string"},"link":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]}},"required":["title","link"]}},"displayMode":{"type":"string","nullable":true,"enum":["amount","percentage"]},"secondaryLinks":{"type":"array","nullable":true,"items":{"type":"object","properties":{"title":{"type":"string"},"link":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]}},"required":["title","link"]}},"displayOrder":{"type":"number"},"cmsQueryId":{"type":"string","nullable":true},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"evaluationMethodId":{"nullable":true},"queryGroupId":{"nullable":true},"interpretDataAs":{"type":"string","nullable":true,"enum":["bigint","date","number","boolean","string","decimal","array"]},"interpretSecondaryDataAs":{"type":"string","nullable":true,"enum":["bigint","date","number","boolean","string","decimal","array"]}},"required":["id","datasetColumnId","sourceDatasetColumnId","specialDataSetType","operator","timeframe","attribute","secondaryAttribute","options","displayMode","secondaryLinks","displayOrder","cmsQueryId","createdAt","updatedAt","createdBy","updatedBy"]}},"queryGroups":{"type":"array","items":{"type":"object","description":"A query group with nested subGroups forming a recursive hierarchy.","title":"RecursiveQueryGroup","properties":{"id":{"type":"string","description":"Unique identifier of the query group"},"evaluationMethodId":{"type":"string","description":"Identifier for the evaluation method"},"operator":{"type":"string","description":"Logical operator applied in the group"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"queries":{"type":"array","description":"List of queries in this group","items":{"$ref":"#/components/schemas/QueriesOutput"}},"createdBy":{"type":"string","description":"ID of member who created the group"},"updatedBy":{"type":"string","description":"ID of member who last updated the group"},"parentGroupId":{"type":["string","null"],"nullable":true,"description":"Optional parent group ID"},"subGroups":{"type":"array","description":"Nested sub query groups","items":{"$ref":"#/components/schemas/RecursiveQueryGroup"}}},"required":["id","evaluationMethodId","operator","createdAt","updatedAt","queries","createdBy","updatedBy","subGroups"]}},"type":{"type":"string","enum":["fixed_risk_matrix","composable_rules_system"]},"scenarioId":{},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true}},"required":["id","purpose","queryBlocksMergeOperator","queries","queryGroups","type","scenarioId","status","createdBy","updatedBy","createdAt","updatedAt"]},"triggerEvaluationMethod":{"type":"object","nullable":true,"properties":{"id":{},"purpose":{"type":"string","enum":["TRIGGER","PRIMARY"]},"queryBlocksMergeOperator":{"type":"string","enum":["AND","OR"]},"queries":{"type":"array","items":{"type":"object","properties":{"id":{},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","nullable":true,"enum":["ACTIVE_USERS_ADDRESSES"]},"value":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"nullable":true},{"type":"array","items":{"type":"string"}},{"nullable":true}]},{"type":"array","items":{"type":"string"}},{"nullable":true}]},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"timeframe":{"type":"string","nullable":true,"enum":["daily","weekly","monthly","yearly"]},"attribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"secondaryAttribute":{"type":"object","nullable":true,"properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"options":{"type":"array","nullable":true,"items":{"type":"object","properties":{"title":{"type":"string"},"link":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]}},"required":["title","link"]}},"displayMode":{"type":"string","nullable":true,"enum":["amount","percentage"]},"secondaryLinks":{"type":"array","nullable":true,"items":{"type":"object","properties":{"title":{"type":"string"},"link":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]}},"required":["title","link"]}},"displayOrder":{"type":"number"},"cmsQueryId":{"type":"string","nullable":true},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"evaluationMethodId":{"nullable":true},"queryGroupId":{"nullable":true},"interpretDataAs":{"type":"string","nullable":true,"enum":["bigint","date","number","boolean","string","decimal","array"]},"interpretSecondaryDataAs":{"type":"string","nullable":true,"enum":["bigint","date","number","boolean","string","decimal","array"]}},"required":["id","datasetColumnId","sourceDatasetColumnId","specialDataSetType","operator","timeframe","attribute","secondaryAttribute","options","displayMode","secondaryLinks","displayOrder","cmsQueryId","createdAt","updatedAt","createdBy","updatedBy"]}},"queryGroups":{"type":"array","items":{"type":"object","description":"A query group with nested subGroups forming a recursive hierarchy.","title":"RecursiveQueryGroup","properties":{"id":{"type":"string","description":"Unique identifier of the query group"},"evaluationMethodId":{"type":"string","description":"Identifier for the evaluation method"},"operator":{"type":"string","description":"Logical operator applied in the group"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"queries":{"type":"array","description":"List of queries in this group","items":{"$ref":"#/components/schemas/QueriesOutput"}},"createdBy":{"type":"string","description":"ID of member who created the group"},"updatedBy":{"type":"string","description":"ID of member who last updated the group"},"parentGroupId":{"type":["string","null"],"nullable":true,"description":"Optional parent group ID"},"subGroups":{"type":"array","description":"Nested sub query groups","items":{"$ref":"#/components/schemas/RecursiveQueryGroup"}}},"required":["id","evaluationMethodId","operator","createdAt","updatedAt","queries","createdBy","updatedBy","subGroups"]}},"type":{"type":"string","enum":["fixed_risk_matrix","composable_rules_system"]},"scenarioId":{},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true}},"required":["id","purpose","queryBlocksMergeOperator","queries","queryGroups","type","scenarioId","status","createdBy","updatedBy","createdAt","updatedAt"]},"actions":{"type":"array","items":{"type":"object","properties":{"id":{},"scenarioId":{},"type":{"type":"string","enum":["SET_CUSTOMER_RISK_LEVEL","SET_CUSTOMER_STATUS","SET_ALERT_RISK_LEVEL","SET_TRANSACTION_RISK_LEVEL","SET_TRANSACTION_STATUS","ASSIGN_COMPLIANCE_OFFICER","CREATE_ALERT","ASSIGN_TAG","BLOCK_ON_CHAIN_TRANSACTION","SET_DATASET_COLUMN_VALUE"]},"value":{"type":"string"},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"trigger":{"type":"string","enum":["ON_TRUE","ON_FALSE","ALWAYS"]},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true}},"required":["id","scenarioId","type","value","status","trigger","createdAt","updatedAt"]}},"mode":{"type":"string","enum":["INTERNAL","EXTERNAL"]},"datasetId":{"nullable":true}},"required":["id","name","type","description","organizationId","workspaceId","createdAt","updatedAt","createdBy","updatedBy","entityType","cmsScenarioId","primaryEvaluationMethod","triggerEvaluationMethod","actions","mode","datasetId"]},"example":{"id":"scenario_a1b2c3d4e5f6","name":"US resident gating policy","type":"BlockchainPolicies","description":"Approves signature-gated requests from US-resident customers.","organizationId":"org_9f8e7d6c5b4a","workspaceId":"ws_3b2a1c4d5e6f","createdAt":"2026-03-14T09:30:00.000Z","updatedAt":"2026-03-14T09:30:00.000Z","createdBy":"api","updatedBy":"api","entityType":"individual","cmsScenarioId":null,"primaryEvaluationMethod":null,"triggerEvaluationMethod":null,"actions":[],"mode":"EXTERNAL","datasetId":null}}}},"401":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]},"example":{"message":"Organization or workspace not found","traceId":"trace_ab12cd34ef56"}}}},"404":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]},"example":{"message":"Organization or workspace not found","traceId":"trace_ab12cd34ef56"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]},"example":{"message":"Organization or workspace not found","traceId":"trace_ab12cd34ef56"}}}}}},"put":{"operationId":"updateScenario","security":[{"workspaceApiKey":[]}],"tags":["Sig Gating Workflows API"],"summary":"Update a scenario","description":"Replaces a scenario's definition (full PUT) by ID within the workspace resolved from the request's API key. The body supplies the scenario name, description, primary evaluation method, and actions; `type` and `mode` are omitted and remain BlockchainPolicies / EXTERNAL. Returns the updated scenario, 404 when it does not exist, or 401 when the API key does not resolve to an organization and workspace.","parameters":[{"schema":{},"required":true,"name":"id","in":"path"},{"schema":{"type":"string"},"required":true,"name":"X-API-Key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","nullable":true},"primaryEvaluationMethod":{"type":"object","properties":{"operator":{"type":"string","enum":["AND","OR"]},"queries":{"type":"array","items":{"type":"object","properties":{"queryId":{"description":"Unique ID for the query"},"id":{"description":"Unique ID for the query"},"requestId":{"type":"number","nullable":true,"description":"Request ID for ZKPs"},"attribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"secondaryAttribute":{"type":"object","nullable":true,"properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"number"}},{"nullable":true}]},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"displayMode":{"type":"string","nullable":true,"enum":["amount","percentage"]},"timeframe":{"type":"string","nullable":true,"enum":["daily","weekly","monthly","yearly"]},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","nullable":true,"enum":["ACTIVE_USERS_ADDRESSES"]}},"required":["attribute","operator"]}},"queryGroups":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Unique ID for the query group"},"operator":{"type":"string","enum":["AND","OR"]},"queries":{"type":"array","items":{"type":"object","properties":{"queryId":{"description":"Unique ID for the query"},"id":{"description":"Unique ID for the query"},"requestId":{"type":"number","nullable":true,"description":"Request ID for ZKPs"},"attribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"secondaryAttribute":{"type":"object","nullable":true,"properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"number"}},{"nullable":true}]},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"displayMode":{"type":"string","nullable":true,"enum":["amount","percentage"]},"timeframe":{"type":"string","nullable":true,"enum":["daily","weekly","monthly","yearly"]},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","nullable":true,"enum":["ACTIVE_USERS_ADDRESSES"]}},"required":["attribute","operator"]}}},"required":["operator","queries"]}}},"required":["operator","queries","queryGroups"]},"actions":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["SET_CUSTOMER_RISK_LEVEL","SET_CUSTOMER_STATUS","SET_ALERT_RISK_LEVEL","SET_TRANSACTION_RISK_LEVEL","SET_TRANSACTION_STATUS","ASSIGN_COMPLIANCE_OFFICER","CREATE_ALERT","ASSIGN_TAG","BLOCK_ON_CHAIN_TRANSACTION","SET_DATASET_COLUMN_VALUE"]},"trigger":{"type":"string","enum":["ON_TRUE","ON_FALSE","ALWAYS"]},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"value":{"type":"string"}},"required":["type","trigger","status","value"]}},"entityType":{"type":"string","enum":["individual","company","transaction"]}},"required":["name","primaryEvaluationMethod","actions"]},"example":{"name":"US resident gating policy","description":"Approves signature-gated requests from US-resident customers.","primaryEvaluationMethod":{"operator":"AND","queries":[{"attribute":{"version":"v1","schema":"Customer","path":"Customer/identityData/nationality"},"operator":"$eq","value":"US"}],"queryGroups":[]},"actions":[{"type":"SET_CUSTOMER_STATUS","trigger":"ON_TRUE","status":"ENABLED","value":"Approved"}],"entityType":"individual"}}}},"responses":{"200":{"description":"Update scenario -- success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{},"name":{"type":"string"},"type":{"type":"string","enum":["PrivacyPreservingMonitoring","IndividualMonitoring","DatasetMonitoring","TransactionMonitoring","TFHE","BlockchainPolicies","CompanyMonitoring"]},"description":{"type":"string","nullable":true},"organizationId":{"type":"string"},"workspaceId":{"type":"string"},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"entityType":{"type":"string","nullable":true,"enum":["individual","company","transaction"]},"cmsScenarioId":{"type":"string","nullable":true},"primaryEvaluationMethod":{"type":"object","nullable":true,"properties":{"id":{},"purpose":{"type":"string","enum":["TRIGGER","PRIMARY"]},"queryBlocksMergeOperator":{"type":"string","enum":["AND","OR"]},"queries":{"type":"array","items":{"type":"object","properties":{"id":{},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","nullable":true,"enum":["ACTIVE_USERS_ADDRESSES"]},"value":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"nullable":true},{"type":"array","items":{"type":"string"}},{"nullable":true}]},{"type":"array","items":{"type":"string"}},{"nullable":true}]},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"timeframe":{"type":"string","nullable":true,"enum":["daily","weekly","monthly","yearly"]},"attribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"secondaryAttribute":{"type":"object","nullable":true,"properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"options":{"type":"array","nullable":true,"items":{"type":"object","properties":{"title":{"type":"string"},"link":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]}},"required":["title","link"]}},"displayMode":{"type":"string","nullable":true,"enum":["amount","percentage"]},"secondaryLinks":{"type":"array","nullable":true,"items":{"type":"object","properties":{"title":{"type":"string"},"link":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]}},"required":["title","link"]}},"displayOrder":{"type":"number"},"cmsQueryId":{"type":"string","nullable":true},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"evaluationMethodId":{"nullable":true},"queryGroupId":{"nullable":true},"interpretDataAs":{"type":"string","nullable":true,"enum":["bigint","date","number","boolean","string","decimal","array"]},"interpretSecondaryDataAs":{"type":"string","nullable":true,"enum":["bigint","date","number","boolean","string","decimal","array"]}},"required":["id","datasetColumnId","sourceDatasetColumnId","specialDataSetType","operator","timeframe","attribute","secondaryAttribute","options","displayMode","secondaryLinks","displayOrder","cmsQueryId","createdAt","updatedAt","createdBy","updatedBy"]}},"queryGroups":{"type":"array","items":{"type":"object","description":"A query group with nested subGroups forming a recursive hierarchy.","title":"RecursiveQueryGroup","properties":{"id":{"type":"string","description":"Unique identifier of the query group"},"evaluationMethodId":{"type":"string","description":"Identifier for the evaluation method"},"operator":{"type":"string","description":"Logical operator applied in the group"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"queries":{"type":"array","description":"List of queries in this group","items":{"$ref":"#/components/schemas/QueriesOutput"}},"createdBy":{"type":"string","description":"ID of member who created the group"},"updatedBy":{"type":"string","description":"ID of member who last updated the group"},"parentGroupId":{"type":["string","null"],"nullable":true,"description":"Optional parent group ID"},"subGroups":{"type":"array","description":"Nested sub query groups","items":{"$ref":"#/components/schemas/RecursiveQueryGroup"}}},"required":["id","evaluationMethodId","operator","createdAt","updatedAt","queries","createdBy","updatedBy","subGroups"]}},"type":{"type":"string","enum":["fixed_risk_matrix","composable_rules_system"]},"scenarioId":{},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true}},"required":["id","purpose","queryBlocksMergeOperator","queries","queryGroups","type","scenarioId","status","createdBy","updatedBy","createdAt","updatedAt"]},"triggerEvaluationMethod":{"type":"object","nullable":true,"properties":{"id":{},"purpose":{"type":"string","enum":["TRIGGER","PRIMARY"]},"queryBlocksMergeOperator":{"type":"string","enum":["AND","OR"]},"queries":{"type":"array","items":{"type":"object","properties":{"id":{},"datasetColumnId":{"nullable":true},"sourceDatasetColumnId":{"nullable":true},"specialDataSetType":{"type":"string","nullable":true,"enum":["ACTIVE_USERS_ADDRESSES"]},"value":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"nullable":true},{"type":"array","items":{"type":"string"}},{"nullable":true}]},{"type":"array","items":{"type":"string"}},{"nullable":true}]},"operator":{"type":"string","enum":["$noop","$eq","$lt","$lte","$gt","$gte","$in","$nin","$ne","$exists","$has","$nhas"]},"timeframe":{"type":"string","nullable":true,"enum":["daily","weekly","monthly","yearly"]},"attribute":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"secondaryAttribute":{"type":"object","nullable":true,"properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]},"options":{"type":"array","nullable":true,"items":{"type":"object","properties":{"title":{"type":"string"},"link":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]}},"required":["title","link"]}},"displayMode":{"type":"string","nullable":true,"enum":["amount","percentage"]},"secondaryLinks":{"type":"array","nullable":true,"items":{"type":"object","properties":{"title":{"type":"string"},"link":{"type":"object","properties":{"version":{"type":"string","enum":["v1"]},"schema":{"type":"string","enum":["Customer","KycSession","Transaction","TfheKycSession","Tfhe","Web3Transaction"]},"path":{"type":"string"}},"required":["version","schema","path"]}},"required":["title","link"]}},"displayOrder":{"type":"number"},"cmsQueryId":{"type":"string","nullable":true},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"evaluationMethodId":{"nullable":true},"queryGroupId":{"nullable":true},"interpretDataAs":{"type":"string","nullable":true,"enum":["bigint","date","number","boolean","string","decimal","array"]},"interpretSecondaryDataAs":{"type":"string","nullable":true,"enum":["bigint","date","number","boolean","string","decimal","array"]}},"required":["id","datasetColumnId","sourceDatasetColumnId","specialDataSetType","operator","timeframe","attribute","secondaryAttribute","options","displayMode","secondaryLinks","displayOrder","cmsQueryId","createdAt","updatedAt","createdBy","updatedBy"]}},"queryGroups":{"type":"array","items":{"type":"object","description":"A query group with nested subGroups forming a recursive hierarchy.","title":"RecursiveQueryGroup","properties":{"id":{"type":"string","description":"Unique identifier of the query group"},"evaluationMethodId":{"type":"string","description":"Identifier for the evaluation method"},"operator":{"type":"string","description":"Logical operator applied in the group"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"queries":{"type":"array","description":"List of queries in this group","items":{"$ref":"#/components/schemas/QueriesOutput"}},"createdBy":{"type":"string","description":"ID of member who created the group"},"updatedBy":{"type":"string","description":"ID of member who last updated the group"},"parentGroupId":{"type":["string","null"],"nullable":true,"description":"Optional parent group ID"},"subGroups":{"type":"array","description":"Nested sub query groups","items":{"$ref":"#/components/schemas/RecursiveQueryGroup"}}},"required":["id","evaluationMethodId","operator","createdAt","updatedAt","queries","createdBy","updatedBy","subGroups"]}},"type":{"type":"string","enum":["fixed_risk_matrix","composable_rules_system"]},"scenarioId":{},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true}},"required":["id","purpose","queryBlocksMergeOperator","queries","queryGroups","type","scenarioId","status","createdBy","updatedBy","createdAt","updatedAt"]},"actions":{"type":"array","items":{"type":"object","properties":{"id":{},"scenarioId":{},"type":{"type":"string","enum":["SET_CUSTOMER_RISK_LEVEL","SET_CUSTOMER_STATUS","SET_ALERT_RISK_LEVEL","SET_TRANSACTION_RISK_LEVEL","SET_TRANSACTION_STATUS","ASSIGN_COMPLIANCE_OFFICER","CREATE_ALERT","ASSIGN_TAG","BLOCK_ON_CHAIN_TRANSACTION","SET_DATASET_COLUMN_VALUE"]},"value":{"type":"string"},"status":{"type":"string","enum":["ENABLED","DISABLED"]},"trigger":{"type":"string","enum":["ON_TRUE","ON_FALSE","ALWAYS"]},"createdAt":{"type":"string","nullable":true},"updatedAt":{"type":"string","nullable":true}},"required":["id","scenarioId","type","value","status","trigger","createdAt","updatedAt"]}},"mode":{"type":"string","enum":["INTERNAL","EXTERNAL"]},"datasetId":{"nullable":true}},"required":["id","name","type","description","organizationId","workspaceId","createdAt","updatedAt","createdBy","updatedBy","entityType","cmsScenarioId","primaryEvaluationMethod","triggerEvaluationMethod","actions","mode","datasetId"]},"example":{"id":"scenario_a1b2c3d4e5f6","name":"US resident gating policy","type":"BlockchainPolicies","description":"Approves signature-gated requests from US-resident customers.","organizationId":"org_9f8e7d6c5b4a","workspaceId":"ws_3b2a1c4d5e6f","createdAt":"2026-03-14T09:30:00.000Z","updatedAt":"2026-03-14T09:30:00.000Z","createdBy":"api","updatedBy":"api","entityType":"individual","cmsScenarioId":null,"primaryEvaluationMethod":null,"triggerEvaluationMethod":null,"actions":[],"mode":"EXTERNAL","datasetId":null}}}},"401":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]},"example":{"message":"Organization or workspace not found","traceId":"trace_ab12cd34ef56"}}}},"404":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]},"example":{"message":"Organization or workspace not found","traceId":"trace_ab12cd34ef56"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]},"example":{"message":"Organization or workspace not found","traceId":"trace_ab12cd34ef56"}}}}}},"delete":{"operationId":"deleteScenario","security":[{"workspaceApiKey":[]}],"tags":["Sig Gating Workflows API"],"summary":"Delete a scenario","description":"Permanently deletes a scenario by ID within the workspace resolved from the request's API key; deletion cascades to its evaluation methods, queries, query groups, and actions. Deletion is idempotent: responds 204 with no body whether or not the scenario existed, or 401 when the API key does not resolve to an organization and workspace.","parameters":[{"schema":{},"required":true,"name":"id","in":"path"},{"schema":{"type":"string"},"required":true,"name":"X-API-Key","in":"header"}],"responses":{"204":{"description":"Delete scenario -- success"},"401":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]},"example":{"message":"Organization or workspace not found","traceId":"trace_ab12cd34ef56"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"traceId":{"type":"string"}},"required":["message"]},"example":{"message":"Organization or workspace not found","traceId":"trace_ab12cd34ef56"}}}}}}}},"components":{"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false}}}}},"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer"},"workspaceApiKey":{"type":"apiKey","in":"header","name":"X-API-Key"},"jwt":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{},"parameters":{}}}