1. General information
1.1. Authentication
1.3. Postman
Postman is a collaboration platform for API development
Resources
1.4. Test data
2. Relocations
2.1. Intra-relocation
An intra-relocation is a relocation within the same municipality.
Flow
Add a new intra-municipal relocation
1. Get relatives
Use this endpoint to retrieve the relatives of the declarant. This will return 1 or more people. A person has the following attributes:
-
relationship type: This shows the relation of the person to the registered.
-
declarationtype: Similar to relation type but has a distinction between underage and adult children.
-
suitableForRelocation: yes/no - Is the person suitable for relocation. This is yes if there are no obstructions.
-
obstructions: list of possible obstructions (unprocessed relocation, deceased, personlist suspended, etc).
|
Tip
|
Check the API documentation for an up-to-date list of possible values. |
2. Post a relocation
Use this endpoint to add a new intra-municipal relocation. The client can choose to provide an reference ID or not.
The response message will include a generated internal dossier ID along with the reference ID provided by the client. Both the generated dossier ID and client’s reference ID can be used in calls to the search of consent API’s.
Adding consent by the main occupant to an existing intra-municipal relocation
1. Get tasks by BSN of the main occupant
Use this endpoint to retrieve the pending tasks of a specific person. This can be done by:
-
BSN
-
Task type (relocation_consent, etc)
-
Statusses (planned, in_progress, done)
By calling this API with a BSN a 'relocation consent' task will be returned if that person is the main occupant and the relocation is currently awaiting consent.
The response message will include the dossier-ID and dossier-type. That information can then be used to lookup the complete relocation by calling the specific search endpoint described below.
relocationConsentIsRequired:boolean = (
bsn.includes('<bsn of main occupant>')
&& dossierType == 'intra_mun_relocation'
&& taskType == 'relocation_lodging_consent'
&& status == 'planned'
);2. Get relocations by dossier ID
Use this endpoint to retrieve one complete intra-municipal relocation by a specific dossier ID.
The response message will include the relocators, live-in situation and main occupant. These elements could be shown to the UI to the user. The elements 'status', 'liveInApplicable' and 'consent status' will determine if additional consent is required by the main occupant.
If the relocation is not found then status 404: NOT FOUND is returned.
# Optional check based on the relocation response
relocationConsentIsRequired:boolean = (
status == 'incomplete'
&& newAddress.liveIn.liveInApplicable == true
&& newAddress.liveIn.consent == 'PENDING'
);3. Post lodging consent
Use this endpoint to update the lodging consent situation
If the post is successful status 200:OK is return with an empty body.
Add new (complete)
This is an example of a new complete intra-municipal relocation.
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
POST /api/v1/relocations/intra HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MjgsInNjb3BlIjoiYXBpIn0.uVcdw-dU2f-vZ3ThV0_otAJa2E-koVNi34q8THYbXRdKZXniJoXtlyJWmkxvwR8l4d_nB8TtRn8vIIeJEfZaIW5CLa_zke7sfUYCIqIGUmqzEC9Fbb0_nRR4jU1N3y5bZLcOpAolbpk7vCK0YXzEPAKnHrPAEsvuUk5fbTZWqgwxMepZAd19czoXD-dLEBDKixOV5nNoOdg3zu98as35SC1NyX_I99aTZCDsitwrWowWyEdWP5cBUrveH6yQ__d7pF5F1yF1PX4GajP4BVft3unyHwivttjQZ4P2fYRt7_-CnGEgl58JPszc67ZAyjp8YjAyYPxOJwzB9DNSu45WJg
Accept: application/json
Content-Length: 1522
Host: localhost:8080
{
"dossier" : {
"referenceIds" : [ {
"id" : "intra-reloc-1234",
"description" : "description"
} ],
"startDate" : "2019-01-01"
},
"declarant" : {
"bsn" : "999993653",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "12345"
}
},
"newAddress" : {
"street" : "Dorpstraat",
"houseNumber" : 1,
"houseLetter" : "A",
"houseNumberAddition" : "4",
"postalCode" : "1234aa",
"residence" : "Koedijk",
"municipality" : {
"code" : "4567",
"description" : "Alkmaar"
},
"addressFunction" : "LIVING_ADDRESS",
"numberOfResidents" : 2,
"destinationCurrentResidents" : "Destination current residents",
"liveIn" : {
"liveInApplicable" : true,
"consent" : "PENDING",
"consenter" : {
"bsn" : "999990639",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "12345"
}
}
},
"mainOccupant" : {
"bsn" : "999993653",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "12345"
}
}
},
"relocators" : [ {
"bsn" : "2458",
"declarationType" : "AUTHORITY_HOLDER"
}, {
"bsn" : "3116",
"declarationType" : "AUTHORITY_HOLDER"
}, {
"bsn" : "999993653",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "12345"
},
"declarationType" : "REGISTERED"
} ]
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2063
{
"dossier" : {
"dossierId" : "test-1234",
"referenceIds" : [ {
"id" : "returned-id",
"description" : "description"
} ],
"type" : {
"code" : "intra_mun_relocation",
"description" : "Intra-municipal relocation"
},
"status" : {
"code" : "created",
"description" : "Created",
"entryDateTime" : "2021-09-20T15:49:50",
"endStatus" : false
},
"startDate" : "2020-02-01",
"entryDateTime" : "2020-04-28T10:11:12"
},
"declarant" : {
"bsn" : "000000012",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "9876"
}
},
"newAddress" : {
"street" : "Dorpstraat",
"houseNumber" : 1,
"houseLetter" : "L",
"houseNumberAddition" : "T",
"postalCode" : "1234AA",
"residence" : "Oudorp",
"municipality" : {
"code" : "0361"
},
"addressFunction" : "LIVING_ADDRESS",
"numberOfResidents" : 1,
"destinationCurrentResidents" : "Geen idee",
"liveIn" : {
"liveInApplicable" : true,
"consent" : "NOT_APPLICABLE",
"consenter" : {
"bsn" : "000000012",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
}
}
},
"mainOccupant" : {
"bsn" : "000000012",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
}
}
},
"relocators" : [ {
"bsn" : "000000012",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "REGISTERED"
}, {
"bsn" : "000000061",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "PARTNER"
}, {
"bsn" : "000003116",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "AUTHORITY_HOLDER"
}, {
"bsn" : "000002458",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "AUTHORITY_HOLDER"
} ]
}Add new (minimal)
This is an example of a minimal intra-municipal relocation without live-in situation and just the required fields.
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
POST /api/v1/relocations/intra HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MjgsInNjb3BlIjoiYXBpIn0.uVcdw-dU2f-vZ3ThV0_otAJa2E-koVNi34q8THYbXRdKZXniJoXtlyJWmkxvwR8l4d_nB8TtRn8vIIeJEfZaIW5CLa_zke7sfUYCIqIGUmqzEC9Fbb0_nRR4jU1N3y5bZLcOpAolbpk7vCK0YXzEPAKnHrPAEsvuUk5fbTZWqgwxMepZAd19czoXD-dLEBDKixOV5nNoOdg3zu98as35SC1NyX_I99aTZCDsitwrWowWyEdWP5cBUrveH6yQ__d7pF5F1yF1PX4GajP4BVft3unyHwivttjQZ4P2fYRt7_-CnGEgl58JPszc67ZAyjp8YjAyYPxOJwzB9DNSu45WJg
Accept: application/json
Content-Length: 492
Host: localhost:8080
{
"dossier" : {
"startDate" : "2019-01-01"
},
"declarant" : {
"bsn" : "999993653"
},
"newAddress" : {
"houseNumber" : 1,
"postalCode" : "1234AA",
"numberOfResidents" : 2,
"liveIn" : {
"liveInApplicable" : false
}
},
"relocators" : [ {
"bsn" : "999993653",
"declarationType" : "REGISTERED"
}, {
"bsn" : "3116",
"declarationType" : "AUTHORITY_HOLDER"
}, {
"bsn" : "2458",
"declarationType" : "AUTHORITY_HOLDER"
} ]
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2063
{
"dossier" : {
"dossierId" : "test-1234",
"referenceIds" : [ {
"id" : "returned-id",
"description" : "description"
} ],
"type" : {
"code" : "intra_mun_relocation",
"description" : "Intra-municipal relocation"
},
"status" : {
"code" : "created",
"description" : "Created",
"entryDateTime" : "2021-09-20T15:49:50",
"endStatus" : false
},
"startDate" : "2020-02-01",
"entryDateTime" : "2020-04-28T10:11:12"
},
"declarant" : {
"bsn" : "000000012",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "9876"
}
},
"newAddress" : {
"street" : "Dorpstraat",
"houseNumber" : 1,
"houseLetter" : "L",
"houseNumberAddition" : "T",
"postalCode" : "1234AA",
"residence" : "Oudorp",
"municipality" : {
"code" : "0361"
},
"addressFunction" : "LIVING_ADDRESS",
"numberOfResidents" : 1,
"destinationCurrentResidents" : "Geen idee",
"liveIn" : {
"liveInApplicable" : true,
"consent" : "NOT_APPLICABLE",
"consenter" : {
"bsn" : "000000012",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
}
}
},
"mainOccupant" : {
"bsn" : "000000012",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
}
}
},
"relocators" : [ {
"bsn" : "000000012",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "REGISTERED"
}, {
"bsn" : "000000061",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "PARTNER"
}, {
"bsn" : "000003116",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "AUTHORITY_HOLDER"
}, {
"bsn" : "000002458",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "AUTHORITY_HOLDER"
} ]
}Get one by dossier ID
This is an example of a search for one intra-municipal relocation by dossierId
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
GET /api/v1/relocations/intra/test-1234 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MjcsInNjb3BlIjoiYXBpIn0.vS1eLRucl5wtMmwCxNRXyohxsFwfYcfmcsJugUSCBSk9NV7lO4AGRhMYzpReFKsKZmw5hmp5bwM42taWM9TgPNlGfkRKj36OPdbtBqMrIPNrzaLAMdp1fT9J4szdCUHDKJQohXnDjZzXh-cP-JJwcOR9d6l86jYuILt_CecCoPWh81tFGvGXbx1STP4KV_F3gehFPsNuDFDW-NPZ2vlDdGkY_O4J5TrtypXDmO_bMx0c8E1wEnwbYGlvf7RG-d5s6ZpXW7f3tP_MGi22sLb98ZFGYzWY-HMwk9ZSOyz6nWKdaRviVxJ9Br1mOMjdU-u9RnDjHHV7MpoAAkVqQmN6pA
Accept: application/json
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2063
{
"dossier" : {
"dossierId" : "test-1234",
"referenceIds" : [ {
"id" : "returned-id",
"description" : "description"
} ],
"type" : {
"code" : "intra_mun_relocation",
"description" : "Intra-municipal relocation"
},
"status" : {
"code" : "created",
"description" : "Created",
"entryDateTime" : "2021-09-20T15:49:50",
"endStatus" : false
},
"startDate" : "2020-02-01",
"entryDateTime" : "2020-04-28T10:11:12"
},
"declarant" : {
"bsn" : "000000012",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "9876"
}
},
"newAddress" : {
"street" : "Dorpstraat",
"houseNumber" : 1,
"houseLetter" : "L",
"houseNumberAddition" : "T",
"postalCode" : "1234AA",
"residence" : "Oudorp",
"municipality" : {
"code" : "0361"
},
"addressFunction" : "LIVING_ADDRESS",
"numberOfResidents" : 1,
"destinationCurrentResidents" : "Geen idee",
"liveIn" : {
"liveInApplicable" : true,
"consent" : "NOT_APPLICABLE",
"consenter" : {
"bsn" : "000000012",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
}
}
},
"mainOccupant" : {
"bsn" : "000000012",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
}
}
},
"relocators" : [ {
"bsn" : "000000012",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "REGISTERED"
}, {
"bsn" : "000000061",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "PARTNER"
}, {
"bsn" : "000003116",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "AUTHORITY_HOLDER"
}, {
"bsn" : "000002458",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "AUTHORITY_HOLDER"
} ]
}Add lodging consent
This is an example of consent added to a intra-municipal relocation.
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
POST /api/v1/relocations/intra/consent HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MjcsInNjb3BlIjoiYXBpIn0.vS1eLRucl5wtMmwCxNRXyohxsFwfYcfmcsJugUSCBSk9NV7lO4AGRhMYzpReFKsKZmw5hmp5bwM42taWM9TgPNlGfkRKj36OPdbtBqMrIPNrzaLAMdp1fT9J4szdCUHDKJQohXnDjZzXh-cP-JJwcOR9d6l86jYuILt_CecCoPWh81tFGvGXbx1STP4KV_F3gehFPsNuDFDW-NPZ2vlDdGkY_O4J5TrtypXDmO_bMx0c8E1wEnwbYGlvf7RG-d5s6ZpXW7f3tP_MGi22sLb98ZFGYzWY-HMwk9ZSOyz6nWKdaRviVxJ9Br1mOMjdU-u9RnDjHHV7MpoAAkVqQmN6pA
Accept: application/json
Content-Length: 210
Host: localhost:8080
{
"dossierId" : "GYP-3J1",
"consenter" : {
"bsn" : "000000036",
"contactInformation" : {
"email" : "email@procura.nl",
"telephoneNumber" : "9876543"
}
},
"consent" : "APPROVED"
}Response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENYError
This is an example of an error if the provided request is not valid.
Bad request call
When making a unsuccessfull call to this API endpoint because of an invalid request, the following request parameters and body can be expected.
Request
POST /api/v1/relocations/intra HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MjcsInNjb3BlIjoiYXBpIn0.vS1eLRucl5wtMmwCxNRXyohxsFwfYcfmcsJugUSCBSk9NV7lO4AGRhMYzpReFKsKZmw5hmp5bwM42taWM9TgPNlGfkRKj36OPdbtBqMrIPNrzaLAMdp1fT9J4szdCUHDKJQohXnDjZzXh-cP-JJwcOR9d6l86jYuILt_CecCoPWh81tFGvGXbx1STP4KV_F3gehFPsNuDFDW-NPZ2vlDdGkY_O4J5TrtypXDmO_bMx0c8E1wEnwbYGlvf7RG-d5s6ZpXW7f3tP_MGi22sLb98ZFGYzWY-HMwk9ZSOyz6nWKdaRviVxJ9Br1mOMjdU-u9RnDjHHV7MpoAAkVqQmN6pA
Accept: application/json
Content-Length: 459
Host: localhost:8080
{
"dossier" : { },
"declarant" : {
"bsn" : "999993653"
},
"newAddress" : {
"houseNumber" : 1,
"postalCode" : "1234AA",
"numberOfResidents" : 2,
"liveIn" : {
"liveInApplicable" : false
}
},
"relocators" : [ {
"bsn" : "999993653",
"declarationType" : "REGISTERED"
}, {
"bsn" : "3116",
"declarationType" : "AUTHORITY_HOLDER"
}, {
"bsn" : "2458",
"declarationType" : "AUTHORITY_HOLDER"
} ]
}Response
HTTP/1.1 400 Bad Request
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 454
{
"timestamp" : "2024-07-25T12:14:27",
"id" : "a2c414c7-f09b-44fe-b6de-fd867c8dcba5",
"code" : "internalError",
"description" : "The request failed due to an internal server error",
"cause" : {
"message" : "startDate is mandatory"
},
"request" : {
"id" : "bd6b5b95-4943-47a6-b71c-52bbdf1d5f0c",
"details" : "uri=/api/v1/relocations/intra",
"httpStatus" : {
"code" : 400,
"description" : "Bad Request"
}
}
}2.2. Inter-relocation
An inter-relocation is a relocation between municipalities.
Add new (complete)
This is an example of a new complete inter-municipal relocation.
It is basically the same as an inter-municipal relocation, except the previous munipality is required.
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
POST /api/v1/relocations/inter HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzQsInNjb3BlIjoiYXBpIn0.ltpN6XjhZdfD4WNbTZIihaMqmU5B4y5Bc4BmSF_bKxcKTDoZr3kO4wWX5UNdawIwF5V6-nFidU-XHK2WJcLFBg4W7BLgCGn2OMoo2SE2hZMpi1qUrIbIqLOXAN5eA9C1M8tCHR2jRZ4dW4wzB_zRJS_pR-tRFvovP9ZhUtJW9pCLZOUF8wbldW2ibdtxUXJA3C3JkRwls-VD3A3SBqlO_GFt8hR_sVzMsg3NZo1U-QaP8V0L1KRtDVV7n7RuBjMy_XgR63fYsUPxPCRO_BScMABMN_6CQVAsEI55hiZD68-xWTMbgDHik9ZXTS67KrenldMXirfHzQV3WcRurfK-hQ
Accept: application/json
Content-Length: 1607
Host: localhost:8080
{
"dossier" : {
"referenceIds" : [ {
"id" : "inter-reloc-1234",
"description" : "description"
} ],
"startDate" : "2019-01-01"
},
"declarant" : {
"bsn" : "999993653",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "12345"
}
},
"newAddress" : {
"street" : "Dorpstraat",
"houseNumber" : 1,
"houseLetter" : "A",
"houseNumberAddition" : "4",
"postalCode" : "1234aa",
"residence" : "Koedijk",
"municipality" : {
"code" : "4567",
"description" : "Alkmaar"
},
"addressFunction" : "LIVING_ADDRESS",
"numberOfResidents" : 2,
"destinationCurrentResidents" : "Destination current residents",
"liveIn" : {
"liveInApplicable" : true,
"consent" : "PENDING",
"consenter" : {
"bsn" : "999990639",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "12345"
}
}
},
"mainOccupant" : {
"bsn" : "999993653",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "12345"
}
}
},
"previousMunicipality" : {
"code" : "8900",
"description" : "Haarlem"
},
"relocators" : [ {
"bsn" : "2458",
"declarationType" : "AUTHORITY_HOLDER"
}, {
"bsn" : "3116",
"declarationType" : "AUTHORITY_HOLDER"
}, {
"bsn" : "999993653",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "12345"
},
"declarationType" : "REGISTERED"
} ]
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2117
{
"dossier" : {
"dossierId" : "test-1234",
"referenceIds" : [ {
"id" : "returned-id",
"description" : "description"
} ],
"type" : {
"code" : "inter_mun_relocation",
"description" : "Inter-municipal relocation"
},
"status" : {
"code" : "created",
"description" : "Created",
"entryDateTime" : "2021-09-20T15:49:50",
"endStatus" : false
},
"startDate" : "2020-02-01",
"entryDateTime" : "2020-04-28T10:11:12"
},
"declarant" : {
"bsn" : "000000012",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "9876"
}
},
"newAddress" : {
"street" : "Dorpstraat",
"houseNumber" : 1,
"houseLetter" : "L",
"houseNumberAddition" : "T",
"postalCode" : "1234AA",
"residence" : "Oudorp",
"municipality" : {
"code" : "0361"
},
"addressFunction" : "LIVING_ADDRESS",
"numberOfResidents" : 1,
"destinationCurrentResidents" : "Geen idee",
"liveIn" : {
"liveInApplicable" : true,
"consent" : "NOT_APPLICABLE",
"consenter" : {
"bsn" : "000000012",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
}
}
},
"mainOccupant" : {
"bsn" : "000000012",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
}
}
},
"previousMunicipality" : {
"code" : "8900"
},
"relocators" : [ {
"bsn" : "000000012",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "REGISTERED"
}, {
"bsn" : "000000061",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "PARTNER"
}, {
"bsn" : "000003116",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "AUTHORITY_HOLDER"
}, {
"bsn" : "000002458",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "AUTHORITY_HOLDER"
} ]
}Get one by dossier ID
This is an example of a search for one inter-municipal relocation by dossierId
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
GET /api/v1/relocations/inter/test-1234 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzQsInNjb3BlIjoiYXBpIn0.ltpN6XjhZdfD4WNbTZIihaMqmU5B4y5Bc4BmSF_bKxcKTDoZr3kO4wWX5UNdawIwF5V6-nFidU-XHK2WJcLFBg4W7BLgCGn2OMoo2SE2hZMpi1qUrIbIqLOXAN5eA9C1M8tCHR2jRZ4dW4wzB_zRJS_pR-tRFvovP9ZhUtJW9pCLZOUF8wbldW2ibdtxUXJA3C3JkRwls-VD3A3SBqlO_GFt8hR_sVzMsg3NZo1U-QaP8V0L1KRtDVV7n7RuBjMy_XgR63fYsUPxPCRO_BScMABMN_6CQVAsEI55hiZD68-xWTMbgDHik9ZXTS67KrenldMXirfHzQV3WcRurfK-hQ
Accept: application/json
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2117
{
"dossier" : {
"dossierId" : "test-1234",
"referenceIds" : [ {
"id" : "returned-id",
"description" : "description"
} ],
"type" : {
"code" : "inter_mun_relocation",
"description" : "Inter-municipal relocation"
},
"status" : {
"code" : "created",
"description" : "Created",
"entryDateTime" : "2021-09-20T15:49:50",
"endStatus" : false
},
"startDate" : "2020-02-01",
"entryDateTime" : "2020-04-28T10:11:12"
},
"declarant" : {
"bsn" : "000000012",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "9876"
}
},
"newAddress" : {
"street" : "Dorpstraat",
"houseNumber" : 1,
"houseLetter" : "L",
"houseNumberAddition" : "T",
"postalCode" : "1234AA",
"residence" : "Oudorp",
"municipality" : {
"code" : "0361"
},
"addressFunction" : "LIVING_ADDRESS",
"numberOfResidents" : 1,
"destinationCurrentResidents" : "Geen idee",
"liveIn" : {
"liveInApplicable" : true,
"consent" : "NOT_APPLICABLE",
"consenter" : {
"bsn" : "000000012",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
}
}
},
"mainOccupant" : {
"bsn" : "000000012",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
}
}
},
"previousMunicipality" : {
"code" : "8900"
},
"relocators" : [ {
"bsn" : "000000012",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "REGISTERED"
}, {
"bsn" : "000000061",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "PARTNER"
}, {
"bsn" : "000003116",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "AUTHORITY_HOLDER"
}, {
"bsn" : "000002458",
"contactInformation" : {
"email" : "",
"telephoneNumber" : ""
},
"declarationType" : "AUTHORITY_HOLDER"
} ]
}Add lodging consent
This is an example of consent added to a inter-municipal relocation.
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
POST /api/v1/relocations/inter/consent HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzQsInNjb3BlIjoiYXBpIn0.ltpN6XjhZdfD4WNbTZIihaMqmU5B4y5Bc4BmSF_bKxcKTDoZr3kO4wWX5UNdawIwF5V6-nFidU-XHK2WJcLFBg4W7BLgCGn2OMoo2SE2hZMpi1qUrIbIqLOXAN5eA9C1M8tCHR2jRZ4dW4wzB_zRJS_pR-tRFvovP9ZhUtJW9pCLZOUF8wbldW2ibdtxUXJA3C3JkRwls-VD3A3SBqlO_GFt8hR_sVzMsg3NZo1U-QaP8V0L1KRtDVV7n7RuBjMy_XgR63fYsUPxPCRO_BScMABMN_6CQVAsEI55hiZD68-xWTMbgDHik9ZXTS67KrenldMXirfHzQV3WcRurfK-hQ
Accept: application/json
Content-Length: 210
Host: localhost:8080
{
"dossierId" : "GYP-3J1",
"consenter" : {
"bsn" : "000000036",
"contactInformation" : {
"email" : "email@procura.nl",
"telephoneNumber" : "9876543"
}
},
"consent" : "APPROVED"
}Response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY2.3. Relocation info (deprecated)
|
Warning
|
THIS OPERATION IS DEPRECATED. USE 5.4: RELATIVES. |
Information that is usefull for the relocation process
Example 1
This is an example of a request for relocator info.
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
GET /api/v1/relocations/info/relatives/000000048 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzcsInNjb3BlIjoiYXBpIn0.bGvganP1ZN0SFzn0uDXIl6nSmyDyAU4Ru4b6YqUINQ9FeAqkDRbI0chVoG1VWxg-ZBcTDnjrEhiaucz6kAOFIVp8Cq-a_DJneKDTwq6a_QWxY6cWBVrvnzF4qsfqa1H6JPn2Npnz0HfvUtrsEjes7Z1UE-5fc7X1_pfqqls2d1F2HlCJIS4GAiFaFFm5fi0qW60UFIphS46CyB2d3Y_4bgedViMfgPceXKzabqJ_HrfqNAwbw0ia7MabAPRtl2TS3bVNcQhDRS4sxm-C3iSNJUAbiHmFeqF-KPCsYteZOpQpWg26CSkc-lXWgTGI9QXOoWpIOSktqYzIsWBA2BJJqQ
Accept: application/json
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1944
{
"relatives" : [ {
"person" : {
"bsn" : "000000048"
},
"relationshipType" : "REGISTERED",
"declarationType" : "REGISTERED",
"suitableForRelocation" : false,
"obstructions" : [ "EXISTING_RELOCATION" ]
}, {
"person" : {
"bsn" : "000000085"
},
"relationshipType" : "PARTNER",
"declarationType" : "PARTNER",
"suitableForRelocation" : false,
"obstructions" : [ "EXISTING_RELOCATION" ]
}, {
"person" : {
"bsn" : "000000103"
},
"relationshipType" : "CHILD",
"declarationType" : "AUTHORITY_HOLDER",
"suitableForRelocation" : true,
"obstructions" : [ ]
}, {
"person" : {
"bsn" : "000000012"
},
"relationshipType" : "CHILD",
"declarationType" : "PARENT_LIVING_WITH_ADULT_CHILD",
"suitableForRelocation" : true,
"obstructions" : [ ]
}, {
"person" : {
"bsn" : "000000024"
},
"relationshipType" : "CHILD",
"declarationType" : "AUTHORITY_HOLDER",
"suitableForRelocation" : false,
"obstructions" : [ "DIFFERENT_ADDRESS", "PERSON_RECORD_IS_BLOCKED" ]
}, {
"person" : {
"bsn" : "000000073"
},
"relationshipType" : "CHILD",
"suitableForRelocation" : false,
"obstructions" : [ "NO_PERSON_RECORD_FOUND" ]
}, {
"person" : {
"bsn" : "000000036"
},
"relationshipType" : "CHILD",
"declarationType" : "AUTHORITY_HOLDER",
"suitableForRelocation" : true,
"obstructions" : [ ]
}, {
"person" : {
"bsn" : "999990019"
},
"relationshipType" : "PARENT",
"declarationType" : "ADULT_CHILD_LIVING_WITH_PARENTS",
"suitableForRelocation" : false,
"obstructions" : [ "DIFFERENT_ADDRESS" ]
}, {
"person" : {
"bsn" : "000000097"
},
"relationshipType" : "PARENT",
"declarationType" : "ADULT_CHILD_LIVING_WITH_PARENTS",
"suitableForRelocation" : false,
"obstructions" : [ "PERSON_IS_DECEASED" ]
} ]
}Example 2
This is an example of a request for relocator info with an ex-partner
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
GET /api/v1/relocations/info/relatives/000000048 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzcsInNjb3BlIjoiYXBpIn0.bGvganP1ZN0SFzn0uDXIl6nSmyDyAU4Ru4b6YqUINQ9FeAqkDRbI0chVoG1VWxg-ZBcTDnjrEhiaucz6kAOFIVp8Cq-a_DJneKDTwq6a_QWxY6cWBVrvnzF4qsfqa1H6JPn2Npnz0HfvUtrsEjes7Z1UE-5fc7X1_pfqqls2d1F2HlCJIS4GAiFaFFm5fi0qW60UFIphS46CyB2d3Y_4bgedViMfgPceXKzabqJ_HrfqNAwbw0ia7MabAPRtl2TS3bVNcQhDRS4sxm-C3iSNJUAbiHmFeqF-KPCsYteZOpQpWg26CSkc-lXWgTGI9QXOoWpIOSktqYzIsWBA2BJJqQ
Accept: application/json
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 423
{
"relatives" : [ {
"person" : {
"bsn" : "000000048"
},
"relationshipType" : "REGISTERED",
"declarationType" : "REGISTERED",
"suitableForRelocation" : false,
"obstructions" : [ "EXISTING_RELOCATION" ]
}, {
"person" : {
"bsn" : "000000115"
},
"relationshipType" : "EX_PARTNER",
"suitableForRelocation" : false,
"obstructions" : [ "RELATIONSHIP_HAS_ENDED" ]
} ]
}3. Birth
3.1. Birth
Add new
This is an example of a new birth declaration.
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
POST /api/v1/births HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzYsInNjb3BlIjoiYXBpIn0.Nkgro-_Lff8cYs-tFhnnwS93vXaepZSGevfhBIzgeEMyAOcwQxON9yhnk6X43M4FnkYN85G-7NcLatEqaB5KOEZ7YdilyARhj0E8oKueWsdgOk2_1A0XzpKa9cg0IqBxWFOoF8ehyt6sQgicvty_ocmKeyPKJtijcOi8FMMOjObJ1c6ohaAdiegNxlH8WhIA42LnVlnPaFcJcqef8OYDBB8jEvjxdv-_RAJZQXj0JE3CELlybRs-CdFMin6y3mhqSJobv-G9zjzxjJo1eFyMMX-2b1p82ILyv3VBDbY27OIHGe9htdaVUIl9if6SK8nsMtDtD86zcpRyNw7NPIAqeg
Accept: application/json
Content-Length: 1001
Host: localhost:8080
{
"dossier" : {
"referenceIds" : [ {
"id" : "birth-1234",
"description" : "External system"
} ],
"startDate" : "2020-04-02"
},
"qualificationForDeclaringType" : "FATHER",
"declarant" : {
"bsn" : "000000024",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "12345"
}
},
"mother" : {
"bsn" : "000000036",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "12345"
}
},
"fatherDuoMother" : {
"bsn" : "000000048",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "12345"
}
},
"children" : [ {
"firstname" : "John",
"gender" : "MAN",
"birthDateTime" : "2020-04-03T11:12:00"
}, {
"firstname" : "Mary",
"gender" : "WOMAN",
"birthDateTime" : "2020-04-02T14:30:00"
} ],
"nameSelection" : {
"lastname" : "Vries",
"prefix" : "de",
"titlePredicate" : "B"
}
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1113
{
"dossier" : {
"dossierId" : "test-1234",
"description" : "Geboorte",
"referenceIds" : [ {
"id" : "birth-1234",
"description" : "External system"
} ],
"type" : {
"code" : "birth",
"description" : "Birth"
},
"status" : {
"code" : "created",
"description" : "Created",
"entryDateTime" : "2021-09-20T15:49:50",
"endStatus" : false
},
"startDate" : "2020-04-02",
"entryDateTime" : "2020-04-03T10:11:12"
},
"qualificationForDeclaringType" : "FATHER",
"declarant" : {
"bsn" : "000000024",
"contactInformation" : {
"email" : "aangever@procura.nl",
"telephoneNumber" : "7777"
}
},
"mother" : {
"bsn" : "000000036"
},
"fatherDuoMother" : {
"bsn" : "000000048"
},
"children" : [ {
"firstname" : "John",
"gender" : "MAN",
"birthDateTime" : "2020-04-03T11:12:00"
}, {
"firstname" : "Mary",
"gender" : "WOMAN",
"birthDateTime" : "2020-04-02T14:30:00"
} ],
"nameSelection" : {
"lastname" : "Vries",
"prefix" : "de",
"titlePredicate" : "B"
}
}Get one by dossier ID
This is an example of a search for one birth declaration by dossierId
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
GET /api/v1/births/test-1234 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzUsInNjb3BlIjoiYXBpIn0.FCT3xeu3KYMg375Do5-PD9CiownDI2OwtQwiuFnJsOfwKQ6gnfoUKqfZqeAgL_7Xwb1coYdEXR6kvhNkw0lFzpJkqiFsVVmG6PL0A9vhFKTpgrlPv8Aj82AFKpkNB-flr4uWjYC6cgU7EgxqX5klWumvUSx2BgrzNS3MbJTx31AETVQRjCEwBi2OysV7EosjA9ZzsLhZhFYIeKgCTEXNvi-Ra-rtd3IBH_vLBpZAfIi3HeS1Piw2akVJkQnUVMkBNWmG4sWc0IYxwZd9EMTPhdG5l00fvDzTTOkQVC6S699jL3ZqYTJvZVStnoq17VbjgKBf56oPu87ZHv0zeNPTZA
Accept: application/json
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1113
{
"dossier" : {
"dossierId" : "test-1234",
"description" : "Geboorte",
"referenceIds" : [ {
"id" : "birth-1234",
"description" : "External system"
} ],
"type" : {
"code" : "birth",
"description" : "Birth"
},
"status" : {
"code" : "created",
"description" : "Created",
"entryDateTime" : "2021-09-20T15:49:50",
"endStatus" : false
},
"startDate" : "2020-04-02",
"entryDateTime" : "2020-04-03T10:11:12"
},
"qualificationForDeclaringType" : "FATHER",
"declarant" : {
"bsn" : "000000024",
"contactInformation" : {
"email" : "aangever@procura.nl",
"telephoneNumber" : "7777"
}
},
"mother" : {
"bsn" : "000000036"
},
"fatherDuoMother" : {
"bsn" : "000000048"
},
"children" : [ {
"firstname" : "John",
"gender" : "MAN",
"birthDateTime" : "2020-04-03T11:12:00"
}, {
"firstname" : "Mary",
"gender" : "WOMAN",
"birthDateTime" : "2020-04-02T14:30:00"
} ],
"nameSelection" : {
"lastname" : "Vries",
"prefix" : "de",
"titlePredicate" : "B"
}
}3.2. Birth info
Family situation
Checks if at the birthdate of the child the mother was in a legal committed relationship and returns the BSN of the partner.
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
GET /api/v1/births/info/family-situation?bsnMother=000000036&birthDate=2011-01-01 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1NDEsInNjb3BlIjoiYXBpIn0.b3RekPx6FtfygTg3E2S9qWi9BsL6Ft6-4WJR01uFNPmTOnFzIard211gkzYxdeqwiFexvswluvLwmOvv_HBXCU-rdB6VOZwnLZev3t4Ai-xBg77vTYwANGxfyCfqyBIHhEa13klqbU75jDOqzeV3P9DNvPCRI5PELeQyrpWyYA0yU8IhHeh6gUTqUPFEzj5alqRGB8-V6EEkrY9EfIZD5a2PkTJONsg1aIldNPxhdXB8sEP3-2SBCsvk5Iq1KXpAl_cRp5fC5HmSPRAqg06jMnRu7YNHcW1YGMx-4YNWk2BMEBY1OgisvsduWDOzAuyoEqqDu5RZToJmsI7MSL3mBQ
Accept: application/json
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 124
{
"bornInPartnership" : true,
"legalDeceasedPeriodRuleApplicable" : false,
"partner" : {
"bsn" : "000000073"
}
}Name selection
Checks if two people have joint children. It then returns the lastname, prefix and title.
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
GET /api/v1/births/info/name-selection?bsnMother=000000036&bsnFatherOrDuoMother=000000048 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1NDIsInNjb3BlIjoiYXBpIn0.MNdazGRwa8VL16mXMnBxSsidyKCNvhXAoIBuEiIeB68A0L4v4KyR3p7-SKZRADqT3m2CoipOGTrvl0uUDsR_Z98QwAtbENz2511z60_4018BbTTR8K90DENJF7GztiwH-JySduk5LQK1va06P6cTLpFig0DGJdrSfrQM28iwFcwL6g0KeUGGtNYpHiEY_4Nw6S7iGjIdtfbXBIhXyiJHQPEFrprGnVt420aR1vUBvIqXtK3SBpw43zTvZW5HNs6xdZ8h1608xWXfEewQdE51__JRGNVo9suMnxNjXTDXzbtntxp8l-hajhlRgKLMgElKSPzVMkfjsf4iiEKySSKi3g
Accept: application/json
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 101
{
"jointChildren" : true,
"nameSelection" : {
"lastname" : "Vries",
"prefix" : "de"
}
}Acknowledgement
Returns an acknowledgement of a unborn child declared earlier if any.
Successful call
When making a successful call to this API endpoint, the following request parameters and body can be expected.
Request
GET /api/v1/births/info/acknowledgement?bsnMother=999990639 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzMsInNjb3BlIjoiYXBpIn0.gxePr43PjX3bx9jQl2CpyXhkDLwyYcMdp7iPbxZ3n-vWaKKNe8G_8mhE079w2RflRfhMmCPPb33UiYOijWmAud8CBsSQIzsgcwfRO_F-poc2rAFYKoi_RuXF3KS8dWW9IzVewj4DfbF6iAFU0TxlJyoch0tr_eDQHfam2mtVXKc8QF5PwxcmydHS-Y4sR0N2nJ9A3np1rmGID7G9LAJdzo7Eq2Q-VFy2cav0GE_prQhzXhUEPrwFEm-2rKlLqIbgrBazn3KLEDhsgGjpw-WKaANkE4etHh9dCWzFc7PSjGWhxf5Nd4ejp6rzjlRDrM-ZpD17BZqZIqEbu9wcAkADsg
Accept: application/json
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 144
{
"dossierId" : "ABC-203",
"acknowledgerBsn" : "999993872",
"nameSelection" : {
"lastname" : "Meijden",
"prefix" : "van der"
}
}Successful call without acknowledgement
When making a successful call to this API endpoint, the following request parameters and body can be expected. The response shows what to expect when no acknowledgement is found.
Request
GET /api/v1/births/info/acknowledgement?bsnMother=999993653 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzQsInNjb3BlIjoiYXBpIn0.ltpN6XjhZdfD4WNbTZIihaMqmU5B4y5Bc4BmSF_bKxcKTDoZr3kO4wWX5UNdawIwF5V6-nFidU-XHK2WJcLFBg4W7BLgCGn2OMoo2SE2hZMpi1qUrIbIqLOXAN5eA9C1M8tCHR2jRZ4dW4wzB_zRJS_pR-tRFvovP9ZhUtJW9pCLZOUF8wbldW2ibdtxUXJA3C3JkRwls-VD3A3SBqlO_GFt8hR_sVzMsg3NZo1U-QaP8V0L1KRtDVV7n7RuBjMy_XgR63fYsUPxPCRO_BScMABMN_6CQVAsEI55hiZD68-xWTMbgDHik9ZXTS67KrenldMXirfHzQV3WcRurfK-hQ
Accept: application/json
Host: localhost:8080Response
HTTP/1.1 404 Not Found
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY4. Commitment
Add new
This is an example of a new commitment request.
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
POST /api/v1/commitments HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MjksInNjb3BlIjoiYXBpIn0.cyy_DJGD8TTN6mxjUtWFuM_K5Y8lc1cExffh8yFPlJofL_nWKWxdrQ58uoGFl2ubcSrgLTNgEbL8RBODsuxs8_WzaMgfrLrXIAMDsXLQsFa3pY678Qsrr60medHvhvpZMEz5v5Fubi_GRHBvz9xUR0m6YdQait9SEt2EOC2k4jYIVmnBhZ6gYFUA-itbQ8G9k88z2LAeOoc4516R5NGZbDlw1Vytj_AbAx4sk2UTE83fXGTsmeWiVbFsUJkC-UNqPHEIuH64QsM2pUQ1E3Ppg8L1eoRxfu8GAHBoPCnFIcziMghJdt7RSuOMGUPyWyQUd1N7ouebo4xRKF3fZofqzw
Accept: application/json
Content-Length: 2254
Host: localhost:8080
{
"dossier" : {
"referenceIds" : [ {
"id" : "commitment-1234",
"description" : "External system"
} ],
"startDate" : "2020-04-02"
},
"partner1" : {
"bsn" : "000000024",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "06-54 32 23 45"
},
"nameAfterCommitment" : {
"nameUseType" : "N",
"title" : "B",
"prefix" : "de",
"lastname" : "Vries"
}
},
"partner2" : {
"bsn" : "000000036",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "0887708100"
},
"nameAfterCommitment" : {
"nameUseType" : "V",
"title" : "JH",
"lastname" : "Jansen"
}
},
"planning" : {
"commitmentType" : "MARRIAGE",
"commitmentDateTime" : "2020-04-02T11:12:00",
"intentionDate" : "2020-01-02",
"remarks" : "Nice wedding!"
},
"location" : {
"name" : "Het Generaalshuis (Theater aan het Vrijthof)",
"aliases" : [ "generaalshuis" ],
"options" : [ {
"name" : "Taalceremonie",
"value" : "Spaans",
"description" : "Taalceremonie",
"type" : "TEXT",
"aliases" : [ "taal_ceremonie" ]
}, {
"name" : "Max. aantal personen",
"value" : "75",
"description" : "Max. aantal personen (1 - 250)",
"type" : "NUMBER",
"aliases" : [ "taal_ceremonie" ]
}, {
"name" : "Trouwboekje/Partnerschapsboekje",
"value" : "true",
"description" : "Trouwboekje/Partnerschapsboekje",
"type" : "BOOLEAN",
"aliases" : [ "trouwboekje" ]
} ]
},
"officials" : {
"preferences" : [ {
"name" : "Pietje precies",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "06-54 32 23 45"
},
"aliases" : [ "pietje" ]
} ]
},
"witnesses" : {
"numberOfMunicipalWitnesses" : 2,
"chosen" : [ {
"firstname" : "Truus",
"prefix" : "de",
"lastname" : "Vries",
"birthdate" : 19900101,
"remarks" : "First witness!"
}, {
"bsn" : "000000048",
"firstname" : "Klaas",
"lastname" : "Jansen",
"birthdate" : 19800503,
"remarks" : "Second witness!"
} ]
}
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2902
{
"dossier" : {
"dossierId" : "marriage-1234",
"description" : "Huwelijk / GPS in gemeente (Jansen / de Vries / Onbekend)",
"referenceIds" : [ {
"id" : "commitment-1234",
"description" : "PROWEB-PERSONEN"
} ],
"type" : {
"code" : "commitment",
"description" : "Commitment"
},
"status" : {
"code" : "incomplete",
"description" : "Incomplete",
"entryDateTime" : "2020-06-02T13:01:55",
"endStatus" : false
},
"startDate" : "2020-09-10",
"entryDateTime" : "2020-06-02T13:01:26"
},
"partner1" : {
"bsn" : "000000024",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "06-54 32 23 45"
},
"nameAfterCommitment" : {
"nameUseType" : "N",
"title" : "B",
"prefix" : "de",
"lastname" : "Vries"
}
},
"partner2" : {
"bsn" : "000000036",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "0887708100"
},
"nameAfterCommitment" : {
"nameUseType" : "V",
"title" : "JH",
"lastname" : "Jansen"
}
},
"planning" : {
"commitmentType" : "MARRIAGE",
"commitmentDateTime" : "2020-09-10T11:12:00",
"intentionDate" : "2020-06-12",
"remarks" : "Het moet wel mooi weer zijn."
},
"location" : {
"name" : "Het Generaalshuis (Theater aan het Vrijthof)",
"aliases" : [ "generaalshuis", "gh" ],
"options" : [ {
"name" : "Taalceremonie",
"value" : "Spaans",
"description" : "Taalceremonie",
"type" : "TEXT",
"aliases" : [ "taal_ceremonie" ]
}, {
"name" : "Max. aantal personen",
"value" : "75",
"description" : "Max. aantal personen (1 - 250)",
"type" : "NUMBER",
"aliases" : [ "max_personen", "max.aantal.personen" ]
}, {
"name" : "Trouwboekje/Partnerschapsboekje",
"value" : "true",
"description" : "Trouwboekje/Partnerschapsboekje",
"type" : "BOOLEAN",
"aliases" : [ "trouwboekje" ]
} ]
},
"officials" : {
"preferences" : [ {
"name" : "Name 1",
"contactInformation" : {
"email" : "name1@procura.nl",
"telephoneNumber" : "1234"
},
"aliases" : [ "alias1", "alias2", "alias3" ]
} ],
"assigned" : {
"name" : "Name 2",
"contactInformation" : {
"email" : "name2@procura.nl",
"telephoneNumber" : "3231231231"
},
"aliases" : [ "alias4" ]
}
},
"witnesses" : {
"numberOfMunicipalWitnesses" : 2,
"chosen" : [ {
"firstname" : "Truus",
"prefix" : "de",
"lastname" : "Vries",
"birthdate" : 19900101,
"remarks" : "First witness!"
}, {
"bsn" : "000000048",
"firstname" : "Klaas",
"lastname" : "Jansen",
"birthdate" : 19800503,
"remarks" : "Second witness!"
} ]
}
}Update existing
This is an example of an update of an existing commitment.
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
POST /api/v1/commitments/commitment-1234 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzAsInNjb3BlIjoiYXBpIn0.s3qWqJsLy1k6iIOHPfA-EJEICbSUFsArwFs0KcekXjjLyj9GzZx_quLPelh3oQoWcya0mv3zwd0V5bujW4v4pLKwlzaqHbqDIwg2sHNmJDRJTwcGkjUu1Ks-k_jLsA9AuPB5c8y1WD1VFvbV5Zq1lVnfL_rx0nnP_pHDINyNnl9FKw89-RhMjFq9mOVWthKL8L-CYIL9Q_Oy3cLW_rJ3m06b-2iSNS-Tvwqf-UYyn8ArHBklo8fNtfuymzF0OE6erWPixksKTxwVN1gRNotQNaJZIKsGfMdJlRivZoJl3_jigOYVm6n8l-_QiWmDDyVlJvLMVe-BlwGfAX8SnrQWaQ
Accept: application/json
Content-Length: 2148
Host: localhost:8080
{
"dossier" : {
"startDate" : "2020-04-02"
},
"partner1" : {
"bsn" : "000000024",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "06-54 32 23 45"
},
"nameAfterCommitment" : {
"nameUseType" : "N",
"title" : "B",
"prefix" : "de",
"lastname" : "Vries"
}
},
"partner2" : {
"bsn" : "000000036",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "0887708100"
},
"nameAfterCommitment" : {
"nameUseType" : "V",
"title" : "JH",
"lastname" : "Jansen"
}
},
"planning" : {
"commitmentType" : "MARRIAGE",
"commitmentDateTime" : "2020-04-02T11:12:00",
"intentionDate" : "2020-01-02",
"remarks" : "Nice wedding!"
},
"location" : {
"name" : "Het Generaalshuis (Theater aan het Vrijthof)",
"aliases" : [ "generaalshuis" ],
"options" : [ {
"name" : "Taalceremonie",
"value" : "Spaans",
"description" : "Taalceremonie",
"type" : "TEXT",
"aliases" : [ "taal_ceremonie" ]
}, {
"name" : "Max. aantal personen",
"value" : "75",
"description" : "Max. aantal personen (1 - 250)",
"type" : "NUMBER",
"aliases" : [ "taal_ceremonie" ]
}, {
"name" : "Trouwboekje/Partnerschapsboekje",
"value" : "true",
"description" : "Trouwboekje/Partnerschapsboekje",
"type" : "BOOLEAN",
"aliases" : [ "trouwboekje" ]
} ]
},
"officials" : {
"preferences" : [ {
"name" : "Pietje precies",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "06-54 32 23 45"
},
"aliases" : [ "pietje" ]
} ]
},
"witnesses" : {
"numberOfMunicipalWitnesses" : 2,
"chosen" : [ {
"firstname" : "Truus",
"prefix" : "de",
"lastname" : "Vries",
"birthdate" : 19900101,
"remarks" : "First witness!"
}, {
"bsn" : "000000048",
"firstname" : "Klaas",
"lastname" : "Jansen",
"birthdate" : 19800503,
"remarks" : "Second witness!"
} ]
}
}Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2902
{
"dossier" : {
"dossierId" : "marriage-1234",
"description" : "Huwelijk / GPS in gemeente (Jansen / de Vries / Onbekend)",
"referenceIds" : [ {
"id" : "commitment-1234",
"description" : "PROWEB-PERSONEN"
} ],
"type" : {
"code" : "commitment",
"description" : "Commitment"
},
"status" : {
"code" : "incomplete",
"description" : "Incomplete",
"entryDateTime" : "2020-06-02T13:01:55",
"endStatus" : false
},
"startDate" : "2020-09-10",
"entryDateTime" : "2020-06-02T13:01:26"
},
"partner1" : {
"bsn" : "000000024",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "06-54 32 23 45"
},
"nameAfterCommitment" : {
"nameUseType" : "N",
"title" : "B",
"prefix" : "de",
"lastname" : "Vries"
}
},
"partner2" : {
"bsn" : "000000036",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "0887708100"
},
"nameAfterCommitment" : {
"nameUseType" : "V",
"title" : "JH",
"lastname" : "Jansen"
}
},
"planning" : {
"commitmentType" : "MARRIAGE",
"commitmentDateTime" : "2020-09-10T11:12:00",
"intentionDate" : "2020-06-12",
"remarks" : "Het moet wel mooi weer zijn."
},
"location" : {
"name" : "Het Generaalshuis (Theater aan het Vrijthof)",
"aliases" : [ "generaalshuis", "gh" ],
"options" : [ {
"name" : "Taalceremonie",
"value" : "Spaans",
"description" : "Taalceremonie",
"type" : "TEXT",
"aliases" : [ "taal_ceremonie" ]
}, {
"name" : "Max. aantal personen",
"value" : "75",
"description" : "Max. aantal personen (1 - 250)",
"type" : "NUMBER",
"aliases" : [ "max_personen", "max.aantal.personen" ]
}, {
"name" : "Trouwboekje/Partnerschapsboekje",
"value" : "true",
"description" : "Trouwboekje/Partnerschapsboekje",
"type" : "BOOLEAN",
"aliases" : [ "trouwboekje" ]
} ]
},
"officials" : {
"preferences" : [ {
"name" : "Name 1",
"contactInformation" : {
"email" : "name1@procura.nl",
"telephoneNumber" : "1234"
},
"aliases" : [ "alias1", "alias2", "alias3" ]
} ],
"assigned" : {
"name" : "Name 2",
"contactInformation" : {
"email" : "name2@procura.nl",
"telephoneNumber" : "3231231231"
},
"aliases" : [ "alias4" ]
}
},
"witnesses" : {
"numberOfMunicipalWitnesses" : 2,
"chosen" : [ {
"firstname" : "Truus",
"prefix" : "de",
"lastname" : "Vries",
"birthdate" : 19900101,
"remarks" : "First witness!"
}, {
"bsn" : "000000048",
"firstname" : "Klaas",
"lastname" : "Jansen",
"birthdate" : 19800503,
"remarks" : "Second witness!"
} ]
}
}Get one by dossier ID
This is an example of a search for one commitment request by dossierId
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
GET /api/v1/commitments/marriage-1234 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzAsInNjb3BlIjoiYXBpIn0.s3qWqJsLy1k6iIOHPfA-EJEICbSUFsArwFs0KcekXjjLyj9GzZx_quLPelh3oQoWcya0mv3zwd0V5bujW4v4pLKwlzaqHbqDIwg2sHNmJDRJTwcGkjUu1Ks-k_jLsA9AuPB5c8y1WD1VFvbV5Zq1lVnfL_rx0nnP_pHDINyNnl9FKw89-RhMjFq9mOVWthKL8L-CYIL9Q_Oy3cLW_rJ3m06b-2iSNS-Tvwqf-UYyn8ArHBklo8fNtfuymzF0OE6erWPixksKTxwVN1gRNotQNaJZIKsGfMdJlRivZoJl3_jigOYVm6n8l-_QiWmDDyVlJvLMVe-BlwGfAX8SnrQWaQ
Accept: application/json
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2902
{
"dossier" : {
"dossierId" : "marriage-1234",
"description" : "Huwelijk / GPS in gemeente (Jansen / de Vries / Onbekend)",
"referenceIds" : [ {
"id" : "commitment-1234",
"description" : "PROWEB-PERSONEN"
} ],
"type" : {
"code" : "commitment",
"description" : "Commitment"
},
"status" : {
"code" : "incomplete",
"description" : "Incomplete",
"entryDateTime" : "2020-06-02T13:01:55",
"endStatus" : false
},
"startDate" : "2020-09-10",
"entryDateTime" : "2020-06-02T13:01:26"
},
"partner1" : {
"bsn" : "000000024",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "06-54 32 23 45"
},
"nameAfterCommitment" : {
"nameUseType" : "N",
"title" : "B",
"prefix" : "de",
"lastname" : "Vries"
}
},
"partner2" : {
"bsn" : "000000036",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "0887708100"
},
"nameAfterCommitment" : {
"nameUseType" : "V",
"title" : "JH",
"lastname" : "Jansen"
}
},
"planning" : {
"commitmentType" : "MARRIAGE",
"commitmentDateTime" : "2020-09-10T11:12:00",
"intentionDate" : "2020-06-12",
"remarks" : "Het moet wel mooi weer zijn."
},
"location" : {
"name" : "Het Generaalshuis (Theater aan het Vrijthof)",
"aliases" : [ "generaalshuis", "gh" ],
"options" : [ {
"name" : "Taalceremonie",
"value" : "Spaans",
"description" : "Taalceremonie",
"type" : "TEXT",
"aliases" : [ "taal_ceremonie" ]
}, {
"name" : "Max. aantal personen",
"value" : "75",
"description" : "Max. aantal personen (1 - 250)",
"type" : "NUMBER",
"aliases" : [ "max_personen", "max.aantal.personen" ]
}, {
"name" : "Trouwboekje/Partnerschapsboekje",
"value" : "true",
"description" : "Trouwboekje/Partnerschapsboekje",
"type" : "BOOLEAN",
"aliases" : [ "trouwboekje" ]
} ]
},
"officials" : {
"preferences" : [ {
"name" : "Name 1",
"contactInformation" : {
"email" : "name1@procura.nl",
"telephoneNumber" : "1234"
},
"aliases" : [ "alias1", "alias2", "alias3" ]
} ],
"assigned" : {
"name" : "Name 2",
"contactInformation" : {
"email" : "name2@procura.nl",
"telephoneNumber" : "3231231231"
},
"aliases" : [ "alias4" ]
}
},
"witnesses" : {
"numberOfMunicipalWitnesses" : 2,
"chosen" : [ {
"firstname" : "Truus",
"prefix" : "de",
"lastname" : "Vries",
"birthdate" : 19900101,
"remarks" : "First witness!"
}, {
"bsn" : "000000048",
"firstname" : "Klaas",
"lastname" : "Jansen",
"birthdate" : 19800503,
"remarks" : "Second witness!"
} ]
}
}Cancel commitment
This is an example of canceling a commitment.
Successful call
When making a successful call to this API endpoint, the following request parameters and body can be expected.
Request
POST /api/v1/commitments/marriage-1234/cancel HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MjksInNjb3BlIjoiYXBpIn0.cyy_DJGD8TTN6mxjUtWFuM_K5Y8lc1cExffh8yFPlJofL_nWKWxdrQ58uoGFl2ubcSrgLTNgEbL8RBODsuxs8_WzaMgfrLrXIAMDsXLQsFa3pY678Qsrr60medHvhvpZMEz5v5Fubi_GRHBvz9xUR0m6YdQait9SEt2EOC2k4jYIVmnBhZ6gYFUA-itbQ8G9k88z2LAeOoc4516R5NGZbDlw1Vytj_AbAx4sk2UTE83fXGTsmeWiVbFsUJkC-UNqPHEIuH64QsM2pUQ1E3Ppg8L1eoRxfu8GAHBoPCnFIcziMghJdt7RSuOMGUPyWyQUd1N7ouebo4xRKF3fZofqzw
Accept: application/json
Content-Length: 34
Host: localhost:8080
{
"message" : "cancel message"
}Response
HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY5. Deaths
5.1. Death in municipality
Add new
This is an example of a new death in municipality.
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
POST /api/v1/deaths/in-municipality HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzAsInNjb3BlIjoiYXBpIn0.s3qWqJsLy1k6iIOHPfA-EJEICbSUFsArwFs0KcekXjjLyj9GzZx_quLPelh3oQoWcya0mv3zwd0V5bujW4v4pLKwlzaqHbqDIwg2sHNmJDRJTwcGkjUu1Ks-k_jLsA9AuPB5c8y1WD1VFvbV5Zq1lVnfL_rx0nnP_pHDINyNnl9FKw89-RhMjFq9mOVWthKL8L-CYIL9Q_Oy3cLW_rJ3m06b-2iSNS-Tvwqf-UYyn8ArHBklo8fNtfuymzF0OE6erWPixksKTxwVN1gRNotQNaJZIKsGfMdJlRivZoJl3_jigOYVm6n8l-_QiWmDDyVlJvLMVe-BlwGfAX8SnrQWaQ
Accept: application/json
Content-Length: 1866
Host: localhost:8080
{
"dossier" : {
"referenceIds" : [ {
"id" : "death-1234",
"description" : "External system"
} ],
"startDate" : "2020-04-02"
},
"declarant" : {
"bsn" : "000000024",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "12345"
}
},
"deceased" : {
"bsn" : "000000036",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "12345"
},
"firstname" : "Madonna",
"prefix" : "van der",
"titlePredicate" : "JV",
"lastname" : "Kaart",
"birthdate" : 19750307,
"birthplace" : "Leidschendam",
"birthcountry" : {
"code" : "6030"
}
},
"deathByNaturalCauses" : true,
"municipality" : {
"code" : "0637",
"description" : "Zoetermeer"
},
"dateOfDeath" : "2020-08-16",
"timeOfDeath" : "09:10",
"funeralServices" : {
"serviceType" : "BURIAL_CREMATION",
"date" : "2020-08-20",
"time" : "12:20",
"outsideBenelux" : true,
"causeOfDeathType" : "NATURAL_CAUSES",
"countryOfDestination" : {
"code" : "8045",
"description" : "Antigua en Barbuda"
},
"placeOfDestination" : "Timboektoe",
"via" : "Het vliegveld",
"transportation" : "vliegtuig"
},
"correspondence" : {
"communicationType" : "POST",
"organization" : "Procura B.V.",
"departement" : "Burgerzaken",
"name" : "Dhr. F. Janssen",
"email" : "test@procura.nl",
"telephoneNumber" : "123456",
"street" : "Parelweg",
"houseNumber" : 1,
"houseNumberLetter" : "A",
"houseNumberAddition" : "to",
"postalCode" : "1812RS",
"residence" : "Alkmaar"
},
"extracts" : [ {
"code" : "akt1",
"description" : "Akte 1 description",
"amount" : 1
}, {
"code" : "akt2",
"description" : "Akte 2 description",
"amount" : 2
} ]
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2208
{
"dossier" : {
"dossierId" : "death-1234",
"description" : "Overlijden in gemeente (van Logius)",
"referenceIds" : [ {
"id" : "death-1234",
"description" : "External system"
} ],
"type" : {
"code" : "death_in_municipality",
"description" : "Death in municipality"
},
"status" : {
"code" : "incomplete",
"description" : "Incomplete",
"entryDateTime" : "2021-09-20T15:49:50",
"endStatus" : false
},
"startDate" : "2020-08-16",
"entryDateTime" : "2020-04-28T10:11:12"
},
"declarant" : {
"bsn" : "000000024",
"contactInformation" : {
"email" : "aangever@procura.nl",
"telephoneNumber" : "7777"
}
},
"deceased" : {
"bsn" : "000000036",
"firstname" : "Josephus",
"prefix" : "van",
"titlePredicate" : "B",
"lastname" : "Logius",
"birthdate" : 19981112,
"birthplace" : "Zoetermeer",
"birthcountry" : {
"code" : "6030",
"description" : "Nederland"
}
},
"deathByNaturalCauses" : true,
"municipality" : {
"code" : "0398",
"description" : "Heerhugowaard"
},
"dateOfDeath" : "2020-08-16",
"timeOfDeath" : "09:10",
"funeralServices" : {
"serviceType" : "BURIAL_CREMATION",
"date" : "2020-10-30",
"time" : "13:20",
"outsideBenelux" : true,
"causeOfDeathType" : "NON_CONTAGIOUS_DISEASE",
"countryOfDestination" : {
"code" : "8045",
"description" : "Antigua en Barbuda"
},
"placeOfDestination" : "Timboektoe",
"via" : "Het vliegveld",
"transportation" : "Vliegtuig"
},
"correspondence" : {
"communicationType" : "POST",
"organization" : "Procura B.V.",
"departement" : "Burgerzaken",
"name" : "Dhr. F. Janssen",
"email" : "test@procura.nl",
"telephoneNumber" : "123456",
"street" : "Parelweg",
"houseNumber" : 12,
"houseNumberLetter" : "A",
"houseNumberAddition" : "TO",
"postalCode" : "1821RS",
"residence" : "Alkmaar"
},
"extracts" : [ {
"code" : "akte1",
"description" : "Document description 1",
"amount" : 1
}, {
"code" : "akte1",
"description" : "Document description 2",
"amount" : 2
} ]
}Get one by dossier ID
This is an example of a search for one death_in_mun declaration by dossierId
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
GET /api/v1/deaths/in-municipality/death-1234 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzEsInNjb3BlIjoiYXBpIn0.v1npo2LAJz5x2ed1mkGwUEK2vEEKqG4GIRqgWAh88_IhDtPrFdgnFfjNRZQzdGo3AiAw-4wm-QjlwwcBXR7FXeVDMWCriW6_zujUiH1HGBQ2nWITgO2g2m0QIVSOfI9B-x-mh-gFc34rKVVIx8iPXG7lZ2SanGqWXoaXsB1Z6DzozUV7Q2Giet-lbKjNFkij5lbRPY7ua4ERNq_Z37obI1LCl1UtLokv1GO4L0NVd3-hvAgX3D4UOWpHEFVc8uSxfJziNoxVrhrih7h7jpQ5rzDTA_puG_JZclhVRCpDQquKnKzDiH7SdhQQMGzQKr4pvCvbBO3RAZvq9hzVvzHbaw
Accept: application/json
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2208
{
"dossier" : {
"dossierId" : "death-1234",
"description" : "Overlijden in gemeente (van Logius)",
"referenceIds" : [ {
"id" : "death-1234",
"description" : "External system"
} ],
"type" : {
"code" : "death_in_municipality",
"description" : "Death in municipality"
},
"status" : {
"code" : "incomplete",
"description" : "Incomplete",
"entryDateTime" : "2021-09-20T15:49:50",
"endStatus" : false
},
"startDate" : "2020-08-16",
"entryDateTime" : "2020-04-28T10:11:12"
},
"declarant" : {
"bsn" : "000000024",
"contactInformation" : {
"email" : "aangever@procura.nl",
"telephoneNumber" : "7777"
}
},
"deceased" : {
"bsn" : "000000036",
"firstname" : "Josephus",
"prefix" : "van",
"titlePredicate" : "B",
"lastname" : "Logius",
"birthdate" : 19981112,
"birthplace" : "Zoetermeer",
"birthcountry" : {
"code" : "6030",
"description" : "Nederland"
}
},
"deathByNaturalCauses" : true,
"municipality" : {
"code" : "0398",
"description" : "Heerhugowaard"
},
"dateOfDeath" : "2020-08-16",
"timeOfDeath" : "09:10",
"funeralServices" : {
"serviceType" : "BURIAL_CREMATION",
"date" : "2020-10-30",
"time" : "13:20",
"outsideBenelux" : true,
"causeOfDeathType" : "NON_CONTAGIOUS_DISEASE",
"countryOfDestination" : {
"code" : "8045",
"description" : "Antigua en Barbuda"
},
"placeOfDestination" : "Timboektoe",
"via" : "Het vliegveld",
"transportation" : "Vliegtuig"
},
"correspondence" : {
"communicationType" : "POST",
"organization" : "Procura B.V.",
"departement" : "Burgerzaken",
"name" : "Dhr. F. Janssen",
"email" : "test@procura.nl",
"telephoneNumber" : "123456",
"street" : "Parelweg",
"houseNumber" : 12,
"houseNumberLetter" : "A",
"houseNumberAddition" : "TO",
"postalCode" : "1821RS",
"residence" : "Alkmaar"
},
"extracts" : [ {
"code" : "akte1",
"description" : "Document description 1",
"amount" : 1
}, {
"code" : "akte1",
"description" : "Document description 2",
"amount" : 2
} ]
}5.2. Discovered body
Add new
This is an example of a new discovered body case.
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
POST /api/v1/deaths/discovered-body HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzEsInNjb3BlIjoiYXBpIn0.v1npo2LAJz5x2ed1mkGwUEK2vEEKqG4GIRqgWAh88_IhDtPrFdgnFfjNRZQzdGo3AiAw-4wm-QjlwwcBXR7FXeVDMWCriW6_zujUiH1HGBQ2nWITgO2g2m0QIVSOfI9B-x-mh-gFc34rKVVIx8iPXG7lZ2SanGqWXoaXsB1Z6DzozUV7Q2Giet-lbKjNFkij5lbRPY7ua4ERNq_Z37obI1LCl1UtLokv1GO4L0NVd3-hvAgX3D4UOWpHEFVc8uSxfJziNoxVrhrih7h7jpQ5rzDTA_puG_JZclhVRCpDQquKnKzDiH7SdhQQMGzQKr4pvCvbBO3RAZvq9hzVvzHbaw
Accept: application/json
Content-Length: 1815
Host: localhost:8080
{
"dossier" : {
"referenceIds" : [ {
"id" : "discovered-body-1234",
"description" : "External system"
} ],
"startDate" : "2020-04-02"
},
"deceased" : {
"bsn" : "000000036",
"contactInformation" : {
"email" : "burgerzaken@procura.nl",
"telephoneNumber" : "12345"
},
"firstname" : "Madonna",
"prefix" : "van der",
"titlePredicate" : "JV",
"lastname" : "Kaart",
"birthdate" : 19750307,
"birthplace" : "Leidschendam",
"birthcountry" : {
"code" : "6030"
}
},
"writtenDeclarantType" : "PROSECUTOR",
"deathByNaturalCauses" : true,
"municipality" : {
"code" : "0637",
"description" : "Zoetermeer"
},
"dateOfFinding" : "2020-08-16",
"timeOfFinding" : "09:10",
"explanation" : "Found at home by the neighbours",
"funeralServices" : {
"serviceType" : "BURIAL_CREMATION",
"date" : "2020-08-20",
"time" : "12:20",
"outsideBenelux" : true,
"causeOfDeathType" : "NATURAL_CAUSES",
"countryOfDestination" : {
"code" : "8045",
"description" : "Antigua en Barbuda"
},
"placeOfDestination" : "Timboektoe",
"via" : "Het vliegveld",
"transportation" : "vliegtuig"
},
"correspondence" : {
"communicationType" : "POST",
"organization" : "Procura B.V.",
"departement" : "Burgerzaken",
"name" : "Dhr. F. Janssen",
"email" : "test@procura.nl",
"telephoneNumber" : "123456",
"street" : "Parelweg",
"houseNumber" : 1,
"houseNumberLetter" : "A",
"houseNumberAddition" : "to",
"postalCode" : "1812RS",
"residence" : "Alkmaar"
},
"extracts" : [ {
"code" : "akt1",
"description" : "Akte 1 description",
"amount" : 1
}, {
"code" : "akt2",
"description" : "Akte 2 description",
"amount" : 2
} ]
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2133
{
"dossier" : {
"dossierId" : "death-5678",
"description" : "Lijkvinding (van der Kaart)",
"referenceIds" : [ {
"id" : "death-5678",
"description" : "External system"
} ],
"type" : {
"code" : "discovered_body",
"description" : "Discovered body"
},
"status" : {
"code" : "incomplete",
"description" : "Incomplete",
"entryDateTime" : "2021-09-20T15:49:50",
"endStatus" : false
},
"startDate" : "2020-08-16",
"entryDateTime" : "2020-04-28T10:11:12"
},
"deceased" : {
"bsn" : "000000036",
"firstname" : "Madonna",
"prefix" : "van der",
"titlePredicate" : "JV",
"lastname" : "Kaart",
"birthdate" : 19750307,
"birthplace" : "Leidschendam",
"birthcountry" : {
"code" : "6030",
"description" : "Nederland"
}
},
"writtenDeclarantType" : "PROSECUTOR",
"deathByNaturalCauses" : false,
"municipality" : {
"code" : "0398",
"description" : "Heerhugowaard"
},
"dateOfFinding" : "2020-08-16",
"timeOfFinding" : "09:10",
"explanation" : "Gevonden thuis in een stoel",
"funeralServices" : {
"serviceType" : "BURIAL_CREMATION",
"date" : "2020-10-30",
"time" : "13:20",
"outsideBenelux" : true,
"causeOfDeathType" : "NON_CONTAGIOUS_DISEASE",
"countryOfDestination" : {
"code" : "8045",
"description" : "Antigua en Barbuda"
},
"placeOfDestination" : "Timboektoe",
"via" : "Het vliegveld",
"transportation" : "Vliegtuig"
},
"correspondence" : {
"communicationType" : "POST",
"organization" : "Procura B.V.",
"departement" : "Burgerzaken",
"name" : "Dhr. F. Janssen",
"email" : "test@procura.nl",
"telephoneNumber" : "123456",
"street" : "Parelweg",
"houseNumber" : 12,
"houseNumberLetter" : "A",
"houseNumberAddition" : "TO",
"postalCode" : "1821RS",
"residence" : "Alkmaar"
},
"extracts" : [ {
"code" : "akte1",
"description" : "Document description 1",
"amount" : 1
}, {
"code" : "akte1",
"description" : "Document description 2",
"amount" : 2
} ]
}Get one by dossier ID
This is an example of a search for one discovered body case by dossierId
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
GET /api/v1/deaths/discovered-body/death-5678 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzEsInNjb3BlIjoiYXBpIn0.v1npo2LAJz5x2ed1mkGwUEK2vEEKqG4GIRqgWAh88_IhDtPrFdgnFfjNRZQzdGo3AiAw-4wm-QjlwwcBXR7FXeVDMWCriW6_zujUiH1HGBQ2nWITgO2g2m0QIVSOfI9B-x-mh-gFc34rKVVIx8iPXG7lZ2SanGqWXoaXsB1Z6DzozUV7Q2Giet-lbKjNFkij5lbRPY7ua4ERNq_Z37obI1LCl1UtLokv1GO4L0NVd3-hvAgX3D4UOWpHEFVc8uSxfJziNoxVrhrih7h7jpQ5rzDTA_puG_JZclhVRCpDQquKnKzDiH7SdhQQMGzQKr4pvCvbBO3RAZvq9hzVvzHbaw
Accept: application/json
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2133
{
"dossier" : {
"dossierId" : "death-5678",
"description" : "Lijkvinding (van der Kaart)",
"referenceIds" : [ {
"id" : "death-5678",
"description" : "External system"
} ],
"type" : {
"code" : "discovered_body",
"description" : "Discovered body"
},
"status" : {
"code" : "incomplete",
"description" : "Incomplete",
"entryDateTime" : "2021-09-20T15:49:50",
"endStatus" : false
},
"startDate" : "2020-08-16",
"entryDateTime" : "2020-04-28T10:11:12"
},
"deceased" : {
"bsn" : "000000036",
"firstname" : "Madonna",
"prefix" : "van der",
"titlePredicate" : "JV",
"lastname" : "Kaart",
"birthdate" : 19750307,
"birthplace" : "Leidschendam",
"birthcountry" : {
"code" : "6030",
"description" : "Nederland"
}
},
"writtenDeclarantType" : "PROSECUTOR",
"deathByNaturalCauses" : false,
"municipality" : {
"code" : "0398",
"description" : "Heerhugowaard"
},
"dateOfFinding" : "2020-08-16",
"timeOfFinding" : "09:10",
"explanation" : "Gevonden thuis in een stoel",
"funeralServices" : {
"serviceType" : "BURIAL_CREMATION",
"date" : "2020-10-30",
"time" : "13:20",
"outsideBenelux" : true,
"causeOfDeathType" : "NON_CONTAGIOUS_DISEASE",
"countryOfDestination" : {
"code" : "8045",
"description" : "Antigua en Barbuda"
},
"placeOfDestination" : "Timboektoe",
"via" : "Het vliegveld",
"transportation" : "Vliegtuig"
},
"correspondence" : {
"communicationType" : "POST",
"organization" : "Procura B.V.",
"departement" : "Burgerzaken",
"name" : "Dhr. F. Janssen",
"email" : "test@procura.nl",
"telephoneNumber" : "123456",
"street" : "Parelweg",
"houseNumber" : 12,
"houseNumberLetter" : "A",
"houseNumberAddition" : "TO",
"postalCode" : "1821RS",
"residence" : "Alkmaar"
},
"extracts" : [ {
"code" : "akte1",
"description" : "Document description 1",
"amount" : 1
}, {
"code" : "akte1",
"description" : "Document description 2",
"amount" : 2
} ]
}6. Dossiers
6.1. Dossiers
Search dossiers
This is an example of a search for dossiers
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
POST /api/v1/dossiers/search HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzMsInNjb3BlIjoiYXBpIn0.gxePr43PjX3bx9jQl2CpyXhkDLwyYcMdp7iPbxZ3n-vWaKKNe8G_8mhE079w2RflRfhMmCPPb33UiYOijWmAud8CBsSQIzsgcwfRO_F-poc2rAFYKoi_RuXF3KS8dWW9IzVewj4DfbF6iAFU0TxlJyoch0tr_eDQHfam2mtVXKc8QF5PwxcmydHS-Y4sR0N2nJ9A3np1rmGID7G9LAJdzo7Eq2Q-VFy2cav0GE_prQhzXhUEPrwFEm-2rKlLqIbgrBazn3KLEDhsgGjpw-WKaANkE4etHh9dCWzFc7PSjGWhxf5Nd4ejp6rzjlRDrM-ZpD17BZqZIqEbu9wcAkADsg
Accept: application/json
Content-Length: 362
Host: localhost:8080
{
"dossierIds" : [ "zaak-1234" ],
"bsns" : [ "000000036" ],
"statusses" : [ "incomplete" ],
"entryDateTimePeriod" : {
"from" : "2024-07-24T12:14:33.759218533",
"to" : "2024-07-25T12:14:33.759250178"
},
"startDatePeriod" : {
"from" : "2024-07-24",
"to" : "2024-07-25"
},
"paging" : {
"pageNumber" : 0,
"pageSize" : 10
}
}Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 656
{
"result" : {
"elements" : 1,
"totalElements" : 1,
"totalPages" : 1,
"pageNumber" : 0,
"pageSize" : 1,
"content" : [ {
"dossierId" : "zaak-1234",
"description" : "Verhuizing (Binnengemeentelijk, Dorpstraat 1 L T 1234 AA Oudorp)",
"type" : {
"code" : "intra_mun_relocation",
"description" : "Intra-municipal relocation"
},
"status" : {
"code" : "incomplete",
"description" : "Incomplete",
"entryDateTime" : "2021-09-20T15:49:50",
"endStatus" : false
},
"startDate" : "2020-02-01",
"entryDateTime" : "2020-05-07T16:45:49"
} ]
}
}6.2. Dossier documents
Add document to a dossier
This is an example of adding a document to a dossier
Successful call
When making a successful call to this API endpoint, the following request parameters and body can be expected.
Request
POST /api/v1/dossiers/1234-abc-5de/documents HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzIsInNjb3BlIjoiYXBpIn0.Y_kprAH8JDT9ueUJXP-h6NOZL6DOiwe-ievN7sG6fy8Fbza8tur7cCNfTtLpksJ22VrL2fnE9V5sN3ryt7RqxGobLsJjhUEfgYw-Cq9mCo5_aLcGDagYbUJIZA5iP-LhjpLCcjmZpxgES3S5OLTlrs11By-bu6269aBTRa9nbkcbYwVT1wEpB3m8Cuus62Z1qqrqGvTZXPkkwWPM1KIloSSGwvVEXixgLWg_sLfjHIxdpGMa6W9ocamnjGE_cWfvf0SkCnQxtk0s_1wKRfvEKWl42z6M-ChslMj0X4GrZt8j_t-IzsYSMDP41CmbgC8C7LfSAjVslESzmmnZEGsdJA
Accept: application/json
Content-Length: 82
Host: localhost:8080
{
"title" : "A title",
"filename" : "document.txt",
"content" : "dGV4dA=="
}Response
The filename returned has been derived from requested filename but not the same.
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 175
{
"id" : "dXBsb2FkLXRlc3QtMjY0MzQwNTU5NjU0NzU5NDA1",
"title" : "A title",
"filename" : "upload-test-7991873931906390199.txt",
"entryDateTime" : "2021-01-15T10:11:12"
}Get documents
This is an example of getting documents of a dossier
Successful call
When making a successful call to this API endpoint, the following request parameters and body can be expected.
Request
GET /api/v1/dossiers/1234-abc-5de/documents HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzMsInNjb3BlIjoiYXBpIn0.gxePr43PjX3bx9jQl2CpyXhkDLwyYcMdp7iPbxZ3n-vWaKKNe8G_8mhE079w2RflRfhMmCPPb33UiYOijWmAud8CBsSQIzsgcwfRO_F-poc2rAFYKoi_RuXF3KS8dWW9IzVewj4DfbF6iAFU0TxlJyoch0tr_eDQHfam2mtVXKc8QF5PwxcmydHS-Y4sR0N2nJ9A3np1rmGID7G9LAJdzo7Eq2Q-VFy2cav0GE_prQhzXhUEPrwFEm-2rKlLqIbgrBazn3KLEDhsgGjpw-WKaANkE4etHh9dCWzFc7PSjGWhxf5Nd4ejp6rzjlRDrM-ZpD17BZqZIqEbu9wcAkADsg
Accept: application/json
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 358
[ {
"id" : "dXBsb2FkLXRlc3QtMjY0MzQwNTU5NjU0NzU5NDA1",
"title" : "A title",
"filename" : "upload-test-7991873931906390199.txt",
"entryDateTime" : "2021-01-15T10:11:12"
}, {
"id" : "dXBsb2FkLXRlc3QtMjY0MzQwNTU5NjU0NzU5NDA2",
"title" : "A title 2",
"filename" : "upload-test-7991873931906390192.txt",
"entryDateTime" : "2021-01-16T13:14:15"
} ]Get document
This is an example of getting documents of a dossier
Successful call
When making a successful call to this API endpoint, the following request parameters and body can be expected.
Request
GET /api/v1/dossiers/1234-abc-5de/documents/testid HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzMsInNjb3BlIjoiYXBpIn0.gxePr43PjX3bx9jQl2CpyXhkDLwyYcMdp7iPbxZ3n-vWaKKNe8G_8mhE079w2RflRfhMmCPPb33UiYOijWmAud8CBsSQIzsgcwfRO_F-poc2rAFYKoi_RuXF3KS8dWW9IzVewj4DfbF6iAFU0TxlJyoch0tr_eDQHfam2mtVXKc8QF5PwxcmydHS-Y4sR0N2nJ9A3np1rmGID7G9LAJdzo7Eq2Q-VFy2cav0GE_prQhzXhUEPrwFEm-2rKlLqIbgrBazn3KLEDhsgGjpw-WKaANkE4etHh9dCWzFc7PSjGWhxf5Nd4ejp6rzjlRDrM-ZpD17BZqZIqEbu9wcAkADsg
Host: localhost:8080Response
The filename is always document followed by the original extension.
HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-Disposition: attachment; filename="document.txt"
Content-Length: 9
Accept-Ranges: bytes
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
some text6.3. Tasks
Search planned tasks
This is an example of a search for planned tasks related to a dossier or resident
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
POST /api/v1/tasks/search HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MjIsInNjb3BlIjoiYXBpIn0.Hy8S95LS2o6emSnCEIXxIcfXGFTOab5tyel2TQhS5EW9TO0ECLPLUZSMpmo7BPE7TCVKd8pWMC207CGgjUig3K3tWB3qhO7KD-Idb9jTRWviGt752XgEUgsi3liHNtWjTad-JO1gzWON2GImzNROydPUFpJUoTs43eX-14qCA5Uec3KLfYfCK7dh9Li7ErP8oNFyU62h2jIDwrEZc_O5Nlt6wZE9F1sKWgO1OiEeGurertEX4OAR6_p_NuAiazF4EwYlGPSE_w73V6ysEagLUemzYzXG0SGXxHoz7sRHD7u1_f9k5VeugZs5uMA_osbV0Rbnwz8uxQZouoR5uAdagw
Accept: application/json
Content-Length: 145
Host: localhost:8080
{
"bsns" : [ "000000036" ],
"types" : [ {
"code" : "relocation_lodging_consent"
} ],
"statusses" : [ {
"code" : "planned"
} ]
}Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 590
{
"result" : {
"elements" : 1,
"totalElements" : 1,
"totalPages" : 1,
"pageNumber" : 0,
"pageSize" : 1,
"content" : [ {
"bsn" : [ "000000036" ],
"dossierId" : "zaak-1234",
"dossierType" : {
"code" : "intra_mun_relocation",
"description" : "Intra-municipal relocation"
},
"taskType" : {
"code" : "relocation_lodging_consent",
"description" : "Lodging consent is required for this relocation"
},
"status" : {
"code" : "planned",
"description" : "Planned"
}
} ]
}
}6.4. Data import
Import CSV type of data used in other cases
Add new
This is an example of add a data import record
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected. The field 'type' should contain a specific value which determine the required values.
Request
POST /api/v1/dataimport/add HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MzUsInNjb3BlIjoiYXBpIn0.FCT3xeu3KYMg375Do5-PD9CiownDI2OwtQwiuFnJsOfwKQ6gnfoUKqfZqeAgL_7Xwb1coYdEXR6kvhNkw0lFzpJkqiFsVVmG6PL0A9vhFKTpgrlPv8Aj82AFKpkNB-flr4uWjYC6cgU7EgxqX5klWumvUSx2BgrzNS3MbJTx31AETVQRjCEwBi2OysV7EosjA9ZzsLhZhFYIeKgCTEXNvi-Ra-rtd3IBH_vLBpZAfIi3HeS1Piw2akVJkQnUVMkBNWmG4sWc0IYxwZd9EMTPhdG5l00fvDzTTOkQVC6S699jL3ZqYTJvZVStnoq17VbjgKBf56oPu87ZHv0zeNPTZA
Accept: application/json
Content-Length: 861
Host: localhost:8080
{
"name" : "Inschrijvers via Internet",
"type" : "first_registrants_2022",
"records" : [ {
"values" : {
"voornamen" : "Pietje",
"achternaam" : "Puk",
"geboortedatum" : "111",
"leeftijd" : "11"
},
"documents" : [ {
"title" : "My Title",
"filename" : "test.txt",
"entryDateTime" : "2024-07-25T12:14:35",
"content" : "U0dWc2JHOE5DbGR2Y214aw=="
}, {
"title" : "My Title2",
"filename" : "test2.txt",
"entryDateTime" : "2024-07-25T12:14:35",
"content" : "U0dWc2JHOE5DbGR2Y214aw=="
} ]
}, {
"values" : {
"voornamen" : "Donald",
"achternaam" : "Duck",
"geboortedatum" : "01-02-2013",
"leeftijd" : "10"
}
}, {
"values" : {
"voornamen" : "Dagobert",
"achternaam" : "Duck",
"geboortedatum" : "19700405"
}
} ]
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 880
{
"name" : "Inschrijvers via Internet",
"type" : "first_registrants_2022",
"records" : [ {
"values" : {
"Voornamen" : "Pietje",
"Achternaam" : "Puk",
"Geboortedatum" : "111"
},
"remarks" : [ "Geboortedatum: De geboortedatum heeft geen geldig formaat" ]
}, {
"values" : {
"Voornamen" : "Donald",
"Achternaam" : "Duck",
"Geboortedatum" : "20130201"
}
} ],
"remarks" : [ "Veld 'Leeftijd' is onbekend", "Veld 'Voorvoegsel' ontbreekt", "Veld 'Geslacht' ontbreekt", "Veld 'Geboorteplaats' ontbreekt", "Veld 'Geboorteland' ontbreekt", "Veld 'Straatnaam' ontbreekt", "Veld 'Huisnummer' ontbreekt", "Veld 'Huisletter' ontbreekt", "Veld 'Toevoeging' ontbreekt", "Veld 'Postcode' ontbreekt", "Veld 'Woonplaats' ontbreekt", "Veld 'Nationaliteit' ontbreekt", "Veld 'E-mail' ontbreekt", "1 van de 2 regels bevatten fouten" ]
}6.5. Relatives
Information about the relatives.
INFO: This is the replacement for Relocation Info which is now deprecated.
Example 1
This is an example of a request for relative info.
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
GET /api/v1/relatives/000000048 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MjUsInNjb3BlIjoiYXBpIn0.JDqypSRsYc9QBWFkzlA_TLZWmPbkc_AhD6of3HCr2QlupCqnK-gOnJwW6MfzwJo8tum_xSnQfRH4lQmApd-SOXUhV5BDHpmQNuwHI3DGhHwQa5FP8B6lwiqkOFDAEP-jq_hz1fLycpVpSOJEe3a6dDy26GkaKvzcqX_lPugg9YAoTZF3Dcoz6-03nMEfplGlUQEtZuCiMS9k0ER2SusFYXH1FplePXa_f2CvGq0e7515HXsJTnWA2ccb9pToax1BAp-ZsI86rIbOXYo_HVfaJ_poNUVcAPmd73CJGyyvCe5WdFUBVOaI7FZCycEk9xa7LaIH0yXobkRhahJdIyY9nQ
Accept: application/json
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2661
{
"relatives" : [ {
"person" : {
"bsn" : "000000048",
"age" : 40
},
"relationshipType" : "REGISTERED",
"declarationType" : "REGISTERED",
"suitableForRelocation" : false,
"suitableFor" : [ "GENERAL_USE_CASE" ],
"obstructions" : [ "EXISTING_RELOCATION_CASE" ]
}, {
"person" : {
"bsn" : "000000085",
"age" : 39
},
"relationshipType" : "PARTNER",
"declarationType" : "PARTNER",
"suitableForRelocation" : false,
"suitableFor" : [ "GENERAL_USE_CASE" ],
"obstructions" : [ "EXISTING_RELOCATION_CASE" ]
}, {
"person" : {
"bsn" : "000000103",
"age" : 1
},
"relationshipType" : "CHILD",
"declarationType" : "AUTHORITY_HOLDER",
"suitableForRelocation" : true,
"suitableFor" : [ "GENERAL_USE_CASE", "NEW_RELOCATION_CASE", "NEW_BRP_EXTRACT_CASE", "NEW_CONFIDENTIALITY_CASE" ],
"obstructions" : [ ]
}, {
"person" : {
"bsn" : "000000012",
"age" : 19
},
"relationshipType" : "CHILD",
"declarationType" : "PARENT_LIVING_WITH_ADULT_CHILD",
"suitableForRelocation" : true,
"suitableFor" : [ "GENERAL_USE_CASE", "NEW_RELOCATION_CASE" ],
"obstructions" : [ ]
}, {
"person" : {
"bsn" : "000000024",
"age" : 18
},
"relationshipType" : "CHILD",
"declarationType" : "PARENT_LIVING_WITH_ADULT_CHILD",
"suitableForRelocation" : false,
"suitableFor" : [ "GENERAL_USE_CASE" ],
"obstructions" : [ "DIFFERENT_ADDRESS", "PERSON_RECORD_IS_BLOCKED" ]
}, {
"person" : {
"bsn" : "000000073"
},
"relationshipType" : "CHILD",
"suitableForRelocation" : false,
"suitableFor" : [ ],
"obstructions" : [ "NO_PERSON_RECORD_FOUND" ]
}, {
"person" : {
"bsn" : "000000036",
"age" : 10
},
"relationshipType" : "CHILD",
"declarationType" : "AUTHORITY_HOLDER",
"suitableForRelocation" : true,
"suitableFor" : [ "GENERAL_USE_CASE", "NEW_RELOCATION_CASE", "NEW_BRP_EXTRACT_CASE", "NEW_CONFIDENTIALITY_CASE" ],
"obstructions" : [ ]
}, {
"person" : {
"bsn" : "999990019",
"age" : 72
},
"relationshipType" : "PARENT",
"declarationType" : "ADULT_CHILD_LIVING_WITH_PARENTS",
"suitableForRelocation" : false,
"suitableFor" : [ "GENERAL_USE_CASE" ],
"obstructions" : [ "DIFFERENT_ADDRESS" ]
}, {
"person" : {
"bsn" : "000000097",
"age" : 72
},
"relationshipType" : "PARENT",
"declarationType" : "ADULT_CHILD_LIVING_WITH_PARENTS",
"suitableForRelocation" : false,
"suitableFor" : [ "GENERAL_USE_CASE" ],
"obstructions" : [ "PERSON_IS_DECEASED" ]
} ]
}Example 2
This is an example of a request for relocator info with an ex-partner
Successful call
When making a successfull call to this API endpoint, the following request parameters and body can be expected.
Request
GET /api/v1/relatives/000000048 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3QiLCJzdWIiOiJBcGlBY2Nlc3MiLCJleHAiOjE3MjE5MDI1MjUsInNjb3BlIjoiYXBpIn0.JDqypSRsYc9QBWFkzlA_TLZWmPbkc_AhD6of3HCr2QlupCqnK-gOnJwW6MfzwJo8tum_xSnQfRH4lQmApd-SOXUhV5BDHpmQNuwHI3DGhHwQa5FP8B6lwiqkOFDAEP-jq_hz1fLycpVpSOJEe3a6dDy26GkaKvzcqX_lPugg9YAoTZF3Dcoz6-03nMEfplGlUQEtZuCiMS9k0ER2SusFYXH1FplePXa_f2CvGq0e7515HXsJTnWA2ccb9pToax1BAp-ZsI86rIbOXYo_HVfaJ_poNUVcAPmd73CJGyyvCe5WdFUBVOaI7FZCycEk9xa7LaIH0yXobkRhahJdIyY9nQ
Accept: application/json
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 552
{
"relatives" : [ {
"person" : {
"bsn" : "000000048",
"age" : 40
},
"relationshipType" : "REGISTERED",
"declarationType" : "REGISTERED",
"suitableForRelocation" : false,
"suitableFor" : [ "GENERAL_USE_CASE" ],
"obstructions" : [ "EXISTING_RELOCATION_CASE" ]
}, {
"person" : {
"bsn" : "000000115",
"age" : 39
},
"relationshipType" : "EX_PARTNER",
"suitableForRelocation" : false,
"suitableFor" : [ "GENERAL_USE_CASE" ],
"obstructions" : [ "RELATIONSHIP_HAS_ENDED" ]
} ]
}