Skip to main content
The check-address endpoint lets you verify whether the address stored for a paper delivery request is still valid. It is useful before initiating a new delivery attempt — if the address record has expired, you know you need to trigger a fresh prepare phase to resolve the current address.
Base path: /paper-channel-private/v1This is an internal API. It is not exposed publicly and requires network-level access to the private Paper Channel service.

​
Check address

GET /paper-channel-private/v1/{requestId}/check-address Verify the existence and validity of the notification address associated with the given requestId. Returns the request identifier and the date-time until which the address record remains valid (endValidity). If no address record is found for the requestId, the service returns 404.

​
Path parameters

​
requestId
string
required
The identifier of the paper delivery request whose address you want to verify.This must be an existing requestId from a prepare or send request already submitted to Paper Channel.

​
Responses

StatusMeaning
200Address record found. Returns validity information.
404No address record found for the given requestId.
500Internal server error.

​
200 response — CheckAddressResponse

​
requestId
string
The request identifier, echoed back from the stored record.
​
endValidity
string
The date and time (ISO 8601, UTC) until which the address record is considered valid.After this timestamp the address may no longer reflect the recipient’s current location. When the current time exceeds endValidity, re-run the prepare phase to obtain a refreshed address.Example: 2024-09-15T23:59:59.000Z

​
Use case: validating an address before prepare

Before starting a new delivery attempt, use this endpoint to check whether the address already held by Paper Channel is still current:
1

Call check-address

Submit a GET request with the requestId of the previous prepare or send.
2

Evaluate endValidity

Compare endValidity against the current timestamp.
  • If endValidity is in the future, the stored address is still valid. You can proceed directly to the send phase using the address returned by the previous prepare.
  • If endValidity is in the past, or if the response is 404, the address must be re-validated. Submit a new prepare request.
3

Proceed accordingly

Either re-use the existing address for the send request, or trigger a new prepare to obtain the current address.
curl --request GET \
  --url https://api.paperchannel.pagopa.local/paper-channel-private/v1/ABCD-HILM-YKWX-202202-1_rec0_try1/check-address

{
  "requestId": "ABCD-HILM-YKWX-202202-1_rec0_try1",
  "endValidity": "2024-09-15T23:59:59.000Z"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us