{
  "openapi": "3.1.1",
  "info": {
    "title": "Digitalt Samtykke – HOP-integration",
    "version": "1.5.0"
  },
  "paths": {
    "/api/Integration/ConsentQueryParameters/Json": {
      "head": {
        "tags": [
          "ConsentQueryParameter"
        ],
        "summary": "Kontrollerer at endpointet kan nås. Har ingen sideeffekter og svarer altid 200.",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "post": {
        "tags": [
          "ConsentQueryParameter"
        ],
        "summary": "Åbner myndighedens overblik over samtykker med søgning, aktiv fane, filtre og\nsortering forudfyldt.",
        "parameters": [
          {
            "name": "idp",
            "in": "query",
            "description": "Vælg login på forhånd: \"NemLogin\" eller \"FkaLogin\".",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "required": [
                  "Body"
                ],
                "type": "object",
                "properties": {
                  "Body": {
                    "contentMediaType": "application/json",
                    "contentSchema": {
                      "$ref": "#/components/schemas/ConsentQueryJsonParametersDto"
                    },
                    "type": "string",
                    "description": "JSON-dokument der matcher ConsentQueryJsonParametersDto."
                  }
                }
              },
              "encoding": {
                "Body": {
                  "contentType": "application/json"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "302": {
            "description": "Parametrene er gemt. Browseren viderestilles til listen over samtykker i Digitalt Samtykkes brugerflade."
          },
          "400": {
            "description": "Parametrene kunne ikke godkendes. Svaret er en HTML-fejlside med et sporings-id."
          },
          "415": {
            "description": "Indholdstypen skal være application/x-www-form-urlencoded. Andre indholdstyper afvises, før parametrene læses."
          }
        }
      }
    },
    "/api/Integration/ConsentQueryParameters": {
      "head": {
        "tags": [
          "ConsentQueryParameter"
        ],
        "summary": "Kontrollerer at endpointet kan nås. Har ingen sideeffekter og svarer altid 200.",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "post": {
        "tags": [
          "ConsentQueryParameter"
        ],
        "summary": "Åbner myndighedens overblik over samtykker med søgningen forudfyldt.",
        "parameters": [
          {
            "name": "idp",
            "in": "query",
            "description": "Vælg login på forhånd: \"NemLogin\" eller \"FkaLogin\".",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "required": [
                  "TenantCvr"
                ],
                "type": "object",
                "properties": {
                  "TenantCvr": {
                    "maxLength": 8,
                    "minLength": 0,
                    "type": "string",
                    "description": "Myndighedens CVR-nummer."
                  },
                  "SubjectCpr": {
                    "pattern": "^(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[-]?\\d{4}$",
                    "type": "string",
                    "description": "CPR-nummer der søges på."
                  },
                  "CaseNumber": {
                    "maxLength": 50,
                    "minLength": 0,
                    "type": "string",
                    "description": "Sagsnummer der søges på."
                  }
                },
                "description": "Forudfylder søgningen i myndighedens overblik over samtykker.\nKun CVR-nummeret er påkrævet."
              }
            }
          },
          "required": true
        },
        "responses": {
          "302": {
            "description": "Parametrene er gemt. Browseren viderestilles til listen over samtykker i Digitalt Samtykkes brugerflade."
          },
          "400": {
            "description": "Parametrene kunne ikke godkendes. Svaret er en HTML-fejlside med et sporings-id."
          },
          "415": {
            "description": "Indholdstypen skal være application/x-www-form-urlencoded. Andre indholdstyper afvises, før parametrene læses."
          }
        }
      }
    },
    "/api/Integration/ConsentRequestParameters": {
      "head": {
        "tags": [
          "ConsentRequestParameter"
        ],
        "summary": "Kontrollerer at endpointet kan nås. Har ingen sideeffekter og svarer altid 200.",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "post": {
        "tags": [
          "ConsentRequestParameter"
        ],
        "summary": "Åbner siden, hvor en medarbejder opretter en samtykkeanmodning, med de sendte\nparametre forudfyldt.",
        "parameters": [
          {
            "name": "idp",
            "in": "query",
            "description": "Vælg login på forhånd: \"NemLogin\" eller \"FkaLogin\".",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "required": [
                  "TenantCvr"
                ],
                "type": "object",
                "properties": {
                  "TenantCvr": {
                    "maxLength": 8,
                    "minLength": 0,
                    "type": "string",
                    "description": "Myndighedens CVR-nummer."
                  },
                  "ConsentDeclarationTemplateId": {
                    "type": "string",
                    "description": "Id på den samtykkeerklæringsskabelon, anmodningen skal oprettes ud fra.",
                    "format": "uuid"
                  },
                  "RequesterId": {
                    "type": "string",
                    "description": "Id på afsenderen i den valgte skabelon. Kan kun angives sammen med\nConsentDeclarationTemplateId.",
                    "format": "uuid"
                  },
                  "CaseNumber": {
                    "maxLength": 50,
                    "minLength": 0,
                    "type": "string",
                    "description": "Myndighedens sagsnummer. Kræver at CaseContextName også angives."
                  },
                  "CaseContextName": {
                    "maxLength": 30,
                    "minLength": 0,
                    "type": "string",
                    "description": "Navnet på sagsnummerkonteksten. Er ConsentDeclarationTemplateId angivet, skal navnet\nmatche skabelonens sagsnummerkontekst. Ellers filtreres de skabeloner, medarbejderen\nkan vælge, til dem der matcher værdien."
                  },
                  "ExternalSystemId": {
                    "maxLength": 50,
                    "minLength": 0,
                    "type": "string",
                    "description": "Anvendersystemets egen reference på anmodningen. Skal være unik hos myndigheden:\nfindes der allerede en anmodning eller en samtykkeerklæring med samme id, afvises kaldet."
                  },
                  "SubjectCpr": {
                    "pattern": "^(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[-]?\\d{4}$",
                    "type": "string",
                    "description": "CPR-nummer på den person, samtykket handler om."
                  },
                  "Consenter1Cpr": {
                    "pattern": "^(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[-]?\\d{4}$",
                    "type": "string",
                    "description": "CPR-nummer på den borger, der skal give samtykke. Udelades ved selv-samtykke og må ikke\nvære det samme som SubjectCpr."
                  },
                  "Consenter2Cpr": {
                    "pattern": "^(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[-]?\\d{4}$",
                    "type": "string",
                    "description": "CPR-nummer på den borger, der skal bekræfte anmodningens besvarelse."
                  }
                },
                "description": "Forudfylder siden, hvor en medarbejder opretter en samtykkeanmodning.\nKun CVR-nummeret er påkrævet; medarbejderen kan rette alle felter."
              }
            }
          },
          "required": true
        },
        "responses": {
          "302": {
            "description": "Parametrene er gemt. Browseren viderestilles til den forudfyldte opret-anmodning-side."
          },
          "400": {
            "description": "Parametrene kunne ikke godkendes. Svaret er problem+json med valideringsfejlene og et sporings-id — i produktion dog uden body."
          },
          "415": {
            "description": "Indholdstypen skal være application/x-www-form-urlencoded. Andre indholdstyper afvises, før parametrene læses."
          }
        }
      }
    },
    "/api/Integration/{tenantCvr}/SignedConsentResponseParameters": {
      "head": {
        "tags": [
          "SignedConsentResponseParameter"
        ],
        "summary": "Kontrollerer at endpointet kan nås. Har ingen sideeffekter og svarer altid 200.",
        "parameters": [
          {
            "name": "tenantCvr",
            "in": "path",
            "description": "Myndighedens CVR-nummer.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "post": {
        "tags": [
          "SignedConsentResponseParameter"
        ],
        "summary": "Opretter en samtykkeanmodning og sender borgeren videre til at besvare den.\nParametrene skal være signeret og krypteret.",
        "parameters": [
          {
            "name": "tenantCvr",
            "in": "path",
            "description": "Myndighedens CVR-nummer.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "required": [
                  "Body"
                ],
                "type": "object",
                "properties": {
                  "Body": {
                    "examples": [
                      "eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00ifQ.<krypteret-noegle>.<iv>.<ciphertext>.<tag>"
                    ],
                    "contentMediaType": "application/jose",
                    "contentSchema": {
                      "$ref": "#/components/schemas/ConsentResponseParametersDto"
                    },
                    "pattern": "^[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]*\\.[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]+$",
                    "type": "string",
                    "description": "JWE i compact serialization (RSA-OAEP + A256GCM), krypteret til Digitalt Samtykkes systemcertifikat. Klartekst er en JWS-envelope med felterne jws og certificate, hvor jws er signeret med RS256 under anvendersystemets OCES-systemcertifikat. JWS'ens payload matcher ConsentResponseParametersDto."
                  }
                }
              },
              "encoding": {
                "Body": {
                  "contentType": "application/jose"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "302": {
            "description": "Parametrene er gemt. Borgeren viderestilles til siden hvor samtykket besvares."
          },
          "400": {
            "description": "Envelopen, certifikatet eller parametrene kunne ikke godkendes — herunder en payload der ikke matcher den forventede kontrakt. Svaret er en HTML-fejlside med et sporings-id — dog en kort tekstbesked, hvis Body-feltet mangler helt."
          },
          "500": {
            "description": "En uventet fejl i Digitalt Samtykke. Svaret er en HTML-fejlside med et sporings-id."
          },
          "415": {
            "description": "Indholdstypen skal være application/x-www-form-urlencoded. Andre indholdstyper afvises, før parametrene læses."
          }
        },
        "callbacks": {
          "retursvar": {
            "$request.body#/RedirectionUrl": {
              "head": {
                "summary": "Oppetjek af modtageren, inden borgeren sendes tilbage.",
                "description": "Umiddelbart før Digitalt Samtykkes sender borgeren tilbage på RedirectionUrl, bliver der lavet et oppetjek af modtager serveren. Enhver status der ikke er 5xx tæller som oppe.",
                "responses": {
                  "200": {
                    "description": "Adressen svarer. Enhver status der ikke er 5xx tæller som oppe."
                  }
                }
              },
              "post": {
                "summary": "Retur-POST når borgeren har besvaret anmodningen",
                "description": "Når borgeren har afsluttet anmodningsforløbet, og oppetjekket er gået godt, laves et form-post fra borgerens browser til den RedirectionUrl, forløbet blev startet med.\n\nBemærk: Dette kald kan blive forsøgt flere gange.",
                "requestBody": {
                  "content": {
                    "application/x-www-form-urlencoded": {
                      "schema": {
                        "required": [
                          "Body"
                        ],
                        "type": "object",
                        "properties": {
                          "TraceId": {
                            "type": [
                              "null",
                              "string"
                            ],
                            "description": "Sporings-id for forløbet i W3C traceparent-format. Oplys det ved fejlsøgning hos\nDigitaliseringsstyrelsen."
                          },
                          "Body": {
                            "examples": [
                              "eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00ifQ.<krypteret-noegle>.<iv>.<ciphertext>.<tag>"
                            ],
                            "contentMediaType": "application/jose",
                            "contentSchema": {
                              "$ref": "#/components/schemas/SignedConsentResponsePayload"
                            },
                            "pattern": "^[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]*\\.[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]+$",
                            "type": "string",
                            "description": "JWE i compact serialization (RSA-OAEP + A256GCM), krypteret til anvendersystemets OCES-systemcertifikat — det certifikat der blev sendt med i envelopen, da forløbet blev startet. Klartekst er en JWS signeret med RS256 under Digitalt Samtykkes systemcertifikat. JWS'ens payload matcher SignedConsentResponsePayload."
                          }
                        },
                        "description": "Felterne i den formular, borgerens browser POST'er til anvendersystemets\n`RedirectionUrl`, når et signeret HOP-forløb er færdigt. Indholdstypen er\n`application/x-www-form-urlencoded`."
                      },
                      "encoding": {
                        "Body": {
                          "contentType": "application/jose"
                        }
                      }
                    }
                  },
                  "required": true
                },
                "responses": {
                  "200": {
                    "description": "Kvitteret. I har nu ansvaret for det videre forløb for borgeren."
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/Integration/{tenantCvr}/SignedConsentResponseParameters/Confirm": {
      "head": {
        "tags": [
          "SignedConsentResponseParameter"
        ],
        "summary": "Kontrollerer at endpointet kan nås. Har ingen sideeffekter og svarer altid 200.",
        "parameters": [
          {
            "name": "tenantCvr",
            "in": "path",
            "description": "Myndighedens CVR-nummer.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "post": {
        "tags": [
          "SignedConsentResponseParameter"
        ],
        "summary": "Sender den anden samtykkegiver videre til at bekræfte en besvaret anmodning.\nParametrene skal være signeret og krypteret.",
        "parameters": [
          {
            "name": "tenantCvr",
            "in": "path",
            "description": "Myndighedens CVR-nummer.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "required": [
                  "Body"
                ],
                "type": "object",
                "properties": {
                  "Body": {
                    "examples": [
                      "eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00ifQ.<krypteret-noegle>.<iv>.<ciphertext>.<tag>"
                    ],
                    "contentMediaType": "application/jose",
                    "contentSchema": {
                      "$ref": "#/components/schemas/ConsentResponseConfirmParametersDto"
                    },
                    "pattern": "^[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]*\\.[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]+$",
                    "type": "string",
                    "description": "JWE i compact serialization (RSA-OAEP + A256GCM), krypteret til Digitalt Samtykkes systemcertifikat. Klartekst er en JWS-envelope med felterne jws og certificate, hvor jws er signeret med RS256 under anvendersystemets OCES-systemcertifikat. JWS'ens payload matcher ConsentResponseConfirmParametersDto."
                  }
                }
              },
              "encoding": {
                "Body": {
                  "contentType": "application/jose"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "302": {
            "description": "Parametrene er gemt. Den anden samtykkegiver viderestilles til bekræftelsessiden."
          },
          "400": {
            "description": "Envelopen, certifikatet eller parametrene kunne ikke godkendes — herunder en payload der ikke matcher den forventede kontrakt. Svaret er en HTML-fejlside med et sporings-id — dog en kort tekstbesked, hvis Body-feltet mangler helt."
          },
          "404": {
            "description": "Der findes ingen anmodning med det angivne id, som kan bekræftes."
          },
          "500": {
            "description": "En uventet fejl i Digitalt Samtykke. Svaret har ingen fejlside."
          },
          "415": {
            "description": "Indholdstypen skal være application/x-www-form-urlencoded. Andre indholdstyper afvises, før parametrene læses."
          }
        },
        "callbacks": {
          "retursvar": {
            "$request.body#/RedirectionUrl": {
              "head": {
                "summary": "Oppetjek af modtageren, inden borgeren sendes tilbage.",
                "description": "Umiddelbart før Digitalt Samtykkes sender borgeren tilbage på RedirectionUrl, bliver der lavet et oppetjek af modtager serveren. Enhver status der ikke er 5xx tæller som oppe.",
                "responses": {
                  "200": {
                    "description": "Adressen svarer. Enhver status der ikke er 5xx tæller som oppe."
                  }
                }
              },
              "post": {
                "summary": "Retur-POST når den anden samtykkegiver har bekræftet",
                "description": "Når borgeren har afsluttet bekræftelsesforløbet, og oppetjekket er gået godt, laves et form-post fra borgerens browser til den RedirectionUrl, forløbet blev startet med.\n\nBemærk: Dette kald kan blive forsøgt flere gange.",
                "requestBody": {
                  "content": {
                    "application/x-www-form-urlencoded": {
                      "schema": {
                        "required": [
                          "Body"
                        ],
                        "type": "object",
                        "properties": {
                          "TraceId": {
                            "type": [
                              "null",
                              "string"
                            ],
                            "description": "Sporings-id for forløbet i W3C traceparent-format. Oplys det ved fejlsøgning hos\nDigitaliseringsstyrelsen."
                          },
                          "Body": {
                            "examples": [
                              "eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00ifQ.<krypteret-noegle>.<iv>.<ciphertext>.<tag>"
                            ],
                            "contentMediaType": "application/jose",
                            "contentSchema": {
                              "$ref": "#/components/schemas/SignedConsentConfirmationPayload"
                            },
                            "pattern": "^[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]*\\.[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]+$",
                            "type": "string",
                            "description": "JWE i compact serialization (RSA-OAEP + A256GCM), krypteret til anvendersystemets OCES-systemcertifikat — det certifikat der blev sendt med i envelopen, da forløbet blev startet. Klartekst er en JWS signeret med RS256 under Digitalt Samtykkes systemcertifikat. JWS'ens payload matcher SignedConsentConfirmationPayload."
                          }
                        },
                        "description": "Felterne i den formular, borgerens browser POST'er til anvendersystemets\n`RedirectionUrl`, når et signeret HOP-forløb er færdigt. Indholdstypen er\n`application/x-www-form-urlencoded`."
                      },
                      "encoding": {
                        "Body": {
                          "contentType": "application/jose"
                        }
                      }
                    }
                  },
                  "required": true
                },
                "responses": {
                  "200": {
                    "description": "Kvitteret. I har nu ansvaret for det videre forløb for borgeren."
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ConsentQueryJsonParametersDto": {
        "required": [
          "tenantCvr"
        ],
        "type": "object",
        "properties": {
          "tenantCvr": {
            "maxLength": 8,
            "minLength": 0,
            "type": "string",
            "description": "Myndighedens CVR-nummer."
          },
          "cprQuery": {
            "pattern": "^(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[-]?\\d{4}$",
            "type": [
              "null",
              "string"
            ],
            "description": "CPR-nummer der søges på. Matcher alle roller på et samtykke."
          },
          "caseNumber": {
            "maxLength": 50,
            "minLength": 0,
            "type": [
              "null",
              "string"
            ],
            "description": "Sagsnummer der søges på."
          },
          "tab": {
            "required": [
              "type"
            ],
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "description": "Fane: \"declarations\", \"consents\", \"optouts\" (fravalg), \"optins\" (tilvalg) eller \"requests\".\nFanerne \"optouts\" og \"optins\" vises kun, når søgningen har valg af fanens type; ellers vises\nfanen \"declarations\"."
              },
              "sorting": {
                "type": [
                  "null",
                  "string"
                ],
                "description": "Sortering. Kun værdier der hører til den valgte fane er gyldige.\nFor \"declarations\": \"responsedate-desc\", \"responsedate-asc\". For \"consents\":\n\"subject-asc\", \"subject-desc\", \"casenumber-asc\", \"casenumber-desc\",\n\"declaration-asc\", \"declaration-desc\", \"consent-asc\", \"consent-desc\".\nFor \"optouts\" og \"optins\": \"subject-asc\", \"subject-desc\", \"casenumber-asc\",\n\"casenumber-desc\", \"declaration-asc\", \"declaration-desc\", \"choice-asc\", \"choice-desc\".\nFor \"requests\": \"expires-nearest\", \"expires-farthest\"."
              },
              "statusFilter": {
                "type": [
                  "null",
                  "array"
                ],
                "items": {
                  "type": "string"
                },
                "description": "Statusfilter. For \"declarations\": \"showactive\", \"showinactive\". For \"consents\":\n\"active\", \"rejected\", \"closed\", \"expired\", \"revoked\". For \"optouts\": \"optedout\" (fravalgt),\n\"notoptedout\" (ikke fravalgt), \"expired\" (udløbet), \"invalid\" (ikke gyldigt). For \"optins\":\n\"optedin\" (tilvalgt), \"notoptedin\" (ikke tilvalgt), \"expired\" (udløbet), \"invalid\" (ikke gyldigt).\nIkke understøttet for \"requests\"."
              },
              "templateName": {
                "type": [
                  "null",
                  "array"
                ],
                "items": {
                  "type": "string"
                },
                "description": "Skabelonnavne der filtreres på. Skelner mellem store og små bogstaver."
              },
              "consentName": {
                "type": [
                  "null",
                  "array"
                ],
                "items": {
                  "type": "string"
                },
                "description": "Samtykkenavne der filtreres på. Kun gyldigt for fanen \"consents\"."
              },
              "viewMode": {
                "type": [
                  "null",
                  "string"
                ],
                "description": "Visning: \"table\" eller \"cards\". Kun gyldigt for fanen \"consents\"."
              }
            },
            "description": "Den aktive fane og de filtre og den sortering, der hører til den."
          }
        },
        "description": "Forudfylder myndighedens overblik over samtykker med søgning, aktiv fane,\nfiltre og sortering. Kun CVR-nummeret er påkrævet."
      },
      "ConsentResponseConfirmParametersDto": {
        "required": [
          "tenantCvr",
          "consentDeclarationRequestId",
          "redirectionUrl"
        ],
        "type": "object",
        "properties": {
          "tenantCvr": {
            "maxLength": 8,
            "minLength": 0,
            "pattern": "^\\d{8}$",
            "type": "string",
            "description": "Myndighedens CVR-nummer."
          },
          "consentDeclarationRequestId": {
            "type": "string",
            "description": "Id på anmodningen, som borgeren skal bekræfte. Anmodningen skal afvente bekræftelse.",
            "format": "uuid"
          },
          "redirectionUrl": {
            "type": "string",
            "description": "Adressen borgeren sendes tilbage til efter afslutning af forløbet.\nSkal være en https-adresse og kunne besvare et HEAD-kald.",
            "format": "uri"
          },
          "sendDigitalPostToConsenters": {
            "type": [
              "null",
              "boolean"
            ],
            "description": "Sæt til false hvis anvendersystemet selv tager ansvar for at informere samtykkegiverne\nom afgivelsen af samtykke. Ellers sender Digitalt Samtykke Digital Post til dem med\nbesked om, hvor de kan finde deres samtykker."
          }
        },
        "description": "Sender den anden samtykkegiver videre til at bekræfte en besvaret anmodning."
      },
      "ConsentResponseParametersDto": {
        "required": [
          "tenantCvr",
          "consentDeclarationTemplateId",
          "requesterId",
          "subjectCpr",
          "consenter1Cpr",
          "redirectionUrl"
        ],
        "type": "object",
        "properties": {
          "tenantCvr": {
            "maxLength": 8,
            "minLength": 0,
            "pattern": "^\\d{8}$",
            "type": "string",
            "description": "Myndighedens CVR-nummer."
          },
          "consentDeclarationTemplateId": {
            "type": "string",
            "description": "Id på den samtykkeerklæringsskabelon, anmodningen oprettes ud fra.",
            "format": "uuid"
          },
          "requesterId": {
            "type": "string",
            "description": "Id på afsenderen i den valgte skabelon.",
            "format": "uuid"
          },
          "caseNumber": {
            "maxLength": 50,
            "minLength": 0,
            "type": [
              "null",
              "string"
            ],
            "description": "Myndighedens sagsnummer."
          },
          "externalSystemId": {
            "maxLength": 50,
            "minLength": 0,
            "type": [
              "null",
              "string"
            ],
            "description": "Anvendersystemets egen reference på anmodningen. Skal være unik hos myndigheden:\nfindes der allerede en anmodning eller en samtykkeerklæring med samme id, afvises kaldet."
          },
          "subjectCpr": {
            "pattern": "^(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[-]?\\d{4}$",
            "type": "string",
            "description": "CPR-nummer på den person, samtykket handler om."
          },
          "consenter1Cpr": {
            "pattern": "^(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[-]?\\d{4}$",
            "type": "string",
            "description": "CPR-nummer på den borger, der besvarer anmodningen."
          },
          "consenter2Cpr": {
            "pattern": "^(0[1-9]|[12]\\d|3[01])(0[1-9]|1[0-2])\\d{2}[-]?\\d{4}$",
            "type": [
              "null",
              "string"
            ],
            "description": "CPR-nummer på den borger, der skal bekræfte besvarelsen."
          },
          "steps": {
            "type": "array",
            "items": {
              "required": [
                "stepId"
              ],
              "type": "object",
              "properties": {
                "stepId": {
                  "type": "string",
                  "description": "Trinnets id i skabelonen.",
                  "format": "uuid"
                },
                "grantOptions": {
                  "type": "array",
                  "items": {
                    "required": [
                      "publicKey"
                    ],
                    "type": "object",
                    "properties": {
                      "publicKey": {
                        "maxLength": 50,
                        "minLength": 0,
                        "type": "string",
                        "description": "Valgmulighedens nøgle i skabelonen."
                      },
                      "specifiedClarificationValue": {
                        "maxLength": 50,
                        "minLength": 0,
                        "type": [
                          "null",
                          "string"
                        ],
                        "description": "Præcisering til valgmulighedens tekst. Kræver at valgmuligheden understøtter\npræciseringer."
                      }
                    },
                    "description": "Én valgmulighed på et trin."
                  },
                  "description": "Udvalg af trinnets valgmuligheder. Udelades feltet, medtages alle\nvalgmuligheder på trinnet."
                },
                "additionalChoices": {
                  "type": [
                    "null",
                    "array"
                  ],
                  "items": {
                    "required": [
                      "id"
                    ],
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Det yderligere valgs id i skabelonen, et GUID.",
                        "format": "uuid"
                      }
                    },
                    "description": "Ét yderligere valg på et trin."
                  },
                  "description": "Udvalg af trinnets valgfrie yderligere valg. Udelades feltet, medtages alle valgfrie\nyderligere valg på trinnet. Angives en tom liste, medtages ingen valgfrie. Trinnets\nobligatoriske yderligere valg medtages altid, uanset om de er angivet."
                }
              },
              "description": "Ét trin fra samtykkeerklæringsskabelonen."
            },
            "description": "Udvalg af skabelonens trin. Udelades feltet, medtages alle trin. Angives det, består\nanmodningen kun af de trin og valgmuligheder, der er med - mangler et trin eller en\nvalgmulighed, som skabelonen kræver, afvises kaldet."
          },
          "redirectionUrl": {
            "type": "string",
            "description": "Adressen borgeren sendes tilbage til efter afslutning af forløbet.\nSkal være en https-adresse og kunne besvare et HEAD-kald.",
            "format": "uri"
          },
          "requestConditionsAccepted": {
            "type": [
              "null",
              "boolean"
            ],
            "description": "Sæt til true når skabelonen har anmodningsbetingelser, og anvendersystemet har opfyldt\ndem. Udelad feltet for skabeloner uden. False afvises."
          },
          "sendDigitalPostToConsenters": {
            "type": [
              "null",
              "boolean"
            ],
            "description": "Sæt til false hvis anvendersystemet selv tager ansvar for at informere samtykkegiverne\nom afgivelsen af samtykke. Ellers sender Digitalt Samtykke Digital Post til dem med\nbesked om, hvor de kan finde deres samtykker."
          }
        },
        "description": "Opretter en samtykkeanmodning og sender borgeren videre til at besvare den."
      },
      "SignedConsentConfirmationPayload": {
        "type": "object",
        "properties": {
          "consentDeclarationId": {
            "type": [
              "null",
              "string"
            ],
            "description": "Id på den samtykkeerklæring, der blev oprettet. Anmodningen er færdigbehandlet.",
            "format": "uuid"
          },
          "consenter1DigitalPostStatus": {
            "enum": [
              "Ukendt",
              "Aktiv",
              "Ikkeaktiv"
            ],
            "type": "string",
            "description": "Anmodningsbesvarerens registreringsstatus i Digital Post. Sendes kun til et anvendersystem,\nder er registreret som myndighedens eget anvendersystem, og udelades altid for en 3. part.\nUdelades også, hvis sendDigitalPostToConsenters var sat til false på bekræftelsen."
          },
          "consenter2DigitalPostStatus": {
            "enum": [
              "Ukendt",
              "Aktiv",
              "Ikkeaktiv"
            ],
            "type": "string",
            "description": "Anmodningsbekræfterens registreringsstatus i Digital Post. Sendes kun til et\nanvendersystem, der er registreret som myndighedens eget anvendersystem, og udelades altid\nfor en 3. part. Udelades også, hvis sendDigitalPostToConsenters var sat til false på bekræftelsen."
          },
          "consentDeclarationXml": {
            "type": [
              "null",
              "string"
            ],
            "description": "Samtykkeerklæringen som base64-kodet XML i udvekslingsformatet — XSD'erne ligger under\n/docs/api/schemas. Sendes kun, hvis det er tilvalgt for skabelonen i opsætningen af\nanvendersystemet."
          }
        },
        "description": "Indholdet i retursvaret, når en borger har afsluttet bekræftelsesforløbet."
      },
      "SignedConsentResponsePayload": {
        "type": "object",
        "properties": {
          "consentDeclarationRequestId": {
            "type": [
              "null",
              "string"
            ],
            "description": "Id på den anmodning, der nu afventer bekræftelse. Sendes med, når anmodningen har to\nsamtykkegivere og den første har besvaret den. Brug id'et til at sende den anden\nsamtykkegiver videre til bekræftelse.",
            "format": "uuid"
          },
          "consentDeclarationId": {
            "type": [
              "null",
              "string"
            ],
            "description": "Id på den samtykkeerklæring, der blev oprettet. Sendes med, når anmodningen er\nfærdigbehandlet, altså når den kun har én samtykkegiver.",
            "format": "uuid"
          },
          "consenter1DigitalPostStatus": {
            "enum": [
              "Ukendt",
              "Aktiv",
              "Ikkeaktiv"
            ],
            "type": "string",
            "description": "Anmodningsbesvarerens registreringsstatus i Digital Post. Sendes kun til et anvendersystem,\nder er registreret som myndighedens eget anvendersystem, og udelades altid for en 3. part.\nUdelades også, hvis sendDigitalPostToConsenters var sat til false på anmodningen."
          },
          "consenter2DigitalPostStatus": {
            "enum": [
              "Ukendt",
              "Aktiv",
              "Ikkeaktiv"
            ],
            "type": "string",
            "description": "Anmodningsbekræfterens registreringsstatus i Digital Post. Sendes kun til et\nanvendersystem, der er registreret som myndighedens eget anvendersystem, og udelades altid\nfor en 3. part. Udelades også, hvis anmodningen kun har én samtykkegiver, eller hvis\nsendDigitalPostToConsenters var sat til false på anmodningen."
          },
          "consentDeclarationXml": {
            "type": [
              "null",
              "string"
            ],
            "description": "Samtykkeerklæringen som base64-kodet XML i udvekslingsformatet — XSD'erne ligger under\n/docs/api/schemas. Sendes kun, hvis det er tilvalgt for skabelonen i opsætningen af\nanvendersystemet."
          }
        },
        "description": "Indholdet i retursvaret, når en borger har afsluttet besvarelsesforløbet.\nPræcis ét af `consentDeclarationRequestId` og `consentDeclarationId` er udfyldt,\nog afgør om forløbet er færdigt eller afventer bekræftelsen."
      }
    }
  },
  "tags": [
    {
      "name": "ConsentQueryParameter"
    },
    {
      "name": "ConsentRequestParameter"
    },
    {
      "name": "SignedConsentResponseParameter"
    }
  ]
}
