PATCH Aml/{customerId}/Estate/{estateId}/Contact/{contactId}/Screening
Registrerar resultatet av er screening på parten. Skicka in det så snart ni har ett resultat,
och skicka in igen om resultatet ändras vid en förnyad screening.
Vid träff på någon av indikatorerna skickas en notifiering till objektets mäklare,
och till ytterligare en mäklare om ni anger brokerIdToNotify.
Request Exempel
{
"pep": {
"value": true,
"comment": "Träff mot person i politiskt utsatt ställning, kommunalråd sedan 2021."
},
"sanctionsListMatch": {
"value": false
},
"rca": {
"value": false
},
"sip": {
"value": false
},
"brokerIdToNotify": "9a1c4f22-7d3e-4b8a-b6f1-2c5e9d8a3b47"
}
Request Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ScreeningData",
"type": "object",
"properties": {
"sanctionsListMatch": { "$ref": "#/$defs/riskIndicator", "description": "Träff mot sanktionslista" },
"pep": { "$ref": "#/$defs/riskIndicator", "description": "Person i politiskt utsatt ställning" },
"rca": { "$ref": "#/$defs/riskIndicator", "description": "Känd närstående till PEP" },
"sip": { "$ref": "#/$defs/riskIndicator", "description": "Person med särskild bevakning" },
"brokerIdToNotify": {
"description": "Id på ytterligare en mäklare som ska notifieras utöver objektets mäklare",
"type": ["string", "null"]
}
},
"required": [],
"additionalProperties": false,
"$defs": {
"riskIndicator": {
"type": ["object", "null"],
"properties": {
"value": {
"description": "Indikatorvärde. Utelämna eller sätt null om ni inte har kontrollerat indikatorn",
"type": ["boolean", "null"]
},
"comment": {
"description": "Kommentar till indikatorn. Krävs när value är true",
"type": ["string", "null"]
}
},
"required": [],
"additionalProperties": false
}
}
}
Samtliga indikatorer är valfria. En indikator ni utelämnar lämnas orörd i Vitec Express,
så ni kan skicka in en delmängd. Sätter ni value till true
måste ni ange comment, annars avvisas anropet.
Screening skapar ingen koppling mellan er och processen. Vill ni kunna hitta tillbaka till parten
utifrån ert eget ärendenummer, registrera en utökning under fliken Egen data.
PATCH Aml/{customerId}/Estate/{estateId}/Contact/{contactId}/RiskAssessment
Registrerar kundkännedom och underlag för riskklassificering, typiskt när slutkunden har besvarat
ert kundkännedomsformulär. Utöver screeningindikatorerna kan ni skicka identifiering,
ytterligare riskindikatorer, dokument och en sammanvägd riskklassificering.
Anropet skapar ett underlag som mäklaren sedan tar ställning till i Vitec Express, och en notifiering
skickas till objektets mäklare samt till brokerIdToNotify om det anges.
Processen markeras som att formuläret är besvarat.
Request Exempel
{
"identificationMethod": "BankId",
"identificationDate": "2026-08-14T09:35:00",
"identificationComment": "Identifierad med BankID i vårt formulär.",
"pep": { "value": false },
"sanctionsListMatch": { "value": false },
"rca": { "value": false },
"sip": { "value": false },
"hrtcConnection": {
"value": true,
"comment": "Kunden uppger inkomst från verksamhet i högrisktredjeland."
},
"otherUbo": { "value": false },
"remoteBusinessRelation": {
"value": true,
"comment": "Hela affärsrelationen har skett på distans."
},
"isBasicKycAchieved": true,
"riskLevel": "Medium",
"riskLevelComment": "Distansrelation samt koppling till högrisktredjeland ger förhöjd risk.",
"documents": [
{
"url": "https://my-service.example/documents/kyc-3f2a7c10.pdf",
"name": "Kundkännedomsformulär.pdf"
}
],
"brokerIdToNotify": "9a1c4f22-7d3e-4b8a-b6f1-2c5e9d8a3b47"
}
Request Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "RiskData",
"type": "object",
"properties": {
"identificationMethod": {
"description": "Typ av id-handling som kontrollerats. Kräver att identificationDate anges",
"type": ["string", "null"],
"enum": ["NotSet", "BankId", "DriversLicense", "Passport", "NationaId", "SisId", "ForeignPassport", "ForeignID", "Other", null]
},
"identificationDate": {
"description": "Datum då identifieringen utfördes",
"type": ["string", "null"],
"format": "date-time"
},
"identificationComment": { "type": ["string", "null"] },
"sanctionsListMatch": { "$ref": "#/$defs/riskIndicator" },
"pep": { "$ref": "#/$defs/riskIndicator" },
"rca": { "$ref": "#/$defs/riskIndicator" },
"sip": { "$ref": "#/$defs/riskIndicator" },
"hrtcConnection": { "$ref": "#/$defs/riskIndicator", "description": "Koppling till högrisktredjeland" },
"otherUbo": { "$ref": "#/$defs/riskIndicator", "description": "Annan verklig huvudman" },
"remoteBusinessRelation": { "$ref": "#/$defs/riskIndicator", "description": "Distansaffärsrelation" },
"isBasicKycAchieved": {
"description": "Om grundläggande kundkännedom är uppnådd",
"type": ["boolean", "null"]
},
"riskLevel": {
"description": "Sammanvägd riskklassificering. Kräver att riskLevelComment anges",
"type": ["string", "null"],
"enum": ["NotSet", "Low", "Medium", "High", null]
},
"riskLevelComment": {
"description": "Motivering till vald riskklassificering. Krävs när riskLevel anges",
"type": ["string", "null"]
},
"documents": {
"description": "Dokument som ska hämtas och lagras på objektet",
"type": ["array", "null"],
"items": {
"type": "object",
"properties": {
"url": {
"description": "Url som vi hämtar dokumentet från. Krävs när name är angiven",
"type": ["string", "null"]
},
"name": {
"description": "Visningsnamn inklusive filändelse. Krävs när url är angiven",
"type": ["string", "null"]
}
},
"required": [],
"additionalProperties": false
}
},
"brokerIdToNotify": { "type": ["string", "null"] }
},
"required": [],
"additionalProperties": false,
"$defs": {
"riskIndicator": {
"type": ["object", "null"],
"properties": {
"value": { "type": ["boolean", "null"] },
"comment": {
"description": "Krävs när value är true",
"type": ["string", "null"]
}
},
"required": [],
"additionalProperties": false
}
}
}
Valideringsregler
- Anges
identificationMethod måste identificationDate också anges.
- Anges
riskLevel måste riskLevelComment också anges.
- Sätts en riskindikators
value till true måste comment anges.
- Ett dokument måste ha både
url och name, eller ingen av dem.
Dokument
Vi hämtar varje dokument från den url ni anger och lagrar filen på objektet i Vitec Express,
kopplad till parten. Url:en anropas utan autentisering, så den behöver vara åtkomlig för oss.
Använd gärna en url som är svår att gissa och som slutar gälla efter en tid.
Endast PDF stöds. Filen lagras alltid som PDF, så skicka inte andra filformat.
Sätt name till ett läsbart filnamn, det är namnet mäklaren ser i dokumentlistan.
Kan vi inte hämta filen misslyckas hela anropet, och varken riskbedömning eller övriga
dokument registreras. Kontrollera därför att url:en fungerar innan ni skickar in den.
POST Aml/{customerId}/Estate/{estateId}/Contact/{contactId}/Extension
GET Aml/{customerId}/Estate/{estateId}/Contact/{contactId}/Extension
Här kan ni lagra ert eget id på processen tillsammans med valfri JSON-data.
Använd det för att koppla samman er process med parten i Vitec Express, och för att slippa
egen lagring av kopplingen.
POST skapar eller uppdaterar utökningen, GET hämtar den. Data är helt fri JSON och tolkas inte av oss.
Se även metoden för att lagra och metoden för att hämta.
Request Exempel
{
"id": "case-88213",
"data": {
"caseUrl": "https://my-service.example/cases/88213",
"formSentAt": "2026-08-12T10:02:00Z",
"reminderCount": 1
}
}
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "AmlExtension",
"type": "object",
"properties": {
"id": {
"description": "Ert externa id på processen. Används för att slå upp parten via External-metoden",
"type": ["string", "null"]
},
"data": {
"description": "Valfri JSON. Objekt, array, sträng, tal, boolean eller null"
}
},
"required": [],
"additionalProperties": false
}
Ett GET-anrop för en part som saknar utökning svarar med ett tomt objekt, inte med ett fel.
GET Aml/{customerId}/External/{externalId}/Extension
Slår upp vilken part och vilket objekt en utökning hör till, utifrån det id
ni själva satte på utökningen. Använd det när ni får ett event i ert eget system och bara har ert
eget ärendenummer, och behöver få fram estateId och contactId för att
kunna skicka in screening eller riskbedömning.
Se metoden.
Response Exempel
{
"estateId": "7c1e9b04-52a8-4d6f-9f13-6b0a2d4e8c91",
"contactId": "3f2a7c10-0b44-4f1a-9c2e-8d5b7a1e4f30",
"extension": {
"id": "case-88213",
"data": {
"caseUrl": "https://my-service.example/cases/88213",
"formSentAt": "2026-08-12T10:02:00Z",
"reminderCount": 1
}
}
}
Hittas ingen utökning svarar vi med ett tomt objekt.
