Recipients
Learn how Recipients are populated on Mail Items.
Individual and business recipients
A recipient is a person or business that receives mail at an address. There are two kinds:
- Individual: a single person, such as "Jack Postal."
- Business: the name of the business entity, such as "Acme, Inc."
Recipients let Stable match each envelope to a person or business. Recipients detected on Mail Items are normalized and returned in a structured format so you can use this information consistently in your integration.
For example:
{
"id": "mi_456",
"recipients": {
"line1": { "text": "Jane Doe" },
"line2": { "text": "Acme, Inc." },
"individual": {
"id": "rcp_111",
"firstName": "Jane",
"lastName": "Doe"
},
"business": {
"id": "rcp_222",
"name": "Acme, Inc."
}
}
}Mail without a recognized Recipient will still be delivered to the correct address, but individual and business may be unpopulated.
See Mail Items for more examples.
Managing recipients
Recipients are configured via dashboard, or automatically based on the address authorization information submitted when creating the Location via the Create a location API.
Updated about 23 hours ago
Did this page help you?
