Page tree
Skip to end of metadata
Go to start of metadata



This operation accepts a single name and address and allows you to perform a single NCOA query using an existing OPEN Job ID.

This operation cannot be used to create a new Job ID, since every new Job ID requires a minimum of 100 records as per USPS requirements.
If you do not have a Job ID that is currently OPEN then you must first use the RunNCOALive operation to create a new Job ID by processing at least 100 records.
Afterwards you may then use the newly created Job ID to process requests using the RunNCOALiveSingleAddress operation.

Unlike the RunNCOALive operation, which is SOAP only, this operation also supports the HTTP GET protocol.
Both the SOAP output and the HTTP GET output are in XML.


RunNCOALiveSingleAddress Inputs


Name

Type

Description

Name

String

Name of address resident.

Address

String 

The primary address line.

Address2 

String 

The secondary address.

 City

String

City name.

 State

String 

State abbreviation.

 Zip

String 

Zip code.

JobId

String

User-created string to identify an open Job. Can be any string of 50 characters or less. Cannot contain any of the following characters:  \ / * : ? " < > |

LicenseKey  

String

Your license key to use the service. 
Sign up for a free trial key at
https://www.serviceobjects.com/products/address-geocoding/ncoa-live


 RunNCOALiveSingleAddress Outputs 


The RunNCOALiveSingleAddress output is the same as the RunNCOALive output except that only one NCOA result is returned instead of an arrary of NCOA results.


Name

Type

Values

Description

NameIn

String

Varies

The raw input name.

RawInputAddress

RawInputAddress[]

VariesThe list of raw input addresses.

CASSInputAddress

CASSInputAddress[]

Varies

The list of standardized addresses.

NCOAMatch

NCOAMatch[]

Varies

The list of change of address information

Diagnostics

Diagnostics[]VariesNot currently used.

Error

Error

Varies

Error object indicating why the service could not return a result. See "Errors" page.

JobId [1]

String

Varies

The JobId sent to the service.


RawInputAddress

 Name

TypeValues

Description

Address

StringVaries

The raw input address line

Address2

StringVaries

The raw input address2 line

City

StringVaries

The raw input city

State

StringVaries

The raw input state

Zip

StringVaries

The raw input Zip code


CASSInputAddress

 Name

TypeValues

Description

Address

String

Varies

The standardized address line

Address2

String

Varies

The standardized secondary

City

String

Varies

The standardized city name

State

String

Varies

The standardized state

Zip

String

Varies

The standardized Zip+4

USPSFootnotes

String

Varies

A concatenated string of relevant 2-digit USPS "Footnote" codes that give additional information about the input address.


NCOAMatch

NameTypeValues

Description

NameMatch

String

Varies

The name that matched the COA record.

Address

String

Varies

The primary address line that the resident moved to.

Address2  

String

Varies

The secondary address line.

City

String

Varies

The city name.

State

String

Varies

The state abbreviation.

Zip

String

Varies

The Zip+4.

CarrierRoute

String

Varies

The Carrier Route code for the COA address.

BarcodeDigits

String

Varies

Barcode Example: 931011445011

931011445011
Zip+4Deliver Point Code Checksum Digit

COAFound

String

"True" or "False"

Whether or not a match was found in the COA data. Does not imply that a valid address could be found.

NCOAReturnCode

String

Varies

The USPS's NCOALink Return Code providing additional information about the nature of the COA match

NCOAReturnCodeDesc

String

Varies

Short English description of the COA information.

ExtendedNCOAReturnCode

String

Varies

USPS's Extended NCOA Return Code comprising a series of key/value strings.


Diagnostics

 Name

TypeValues

Description

DiscountCode

String

1-4

A code representing discount level.

DiscountDescription

String

Varies

An English description of the discount level.

StatusCode

String

2-8

A code representing the level of quality of the input address post-validation. Higher is better.

StatusDescription

String

Varies

An English description of the level of quality of the input address post-validation.

ServiceFlags

String

Varies

USPS Service Flags output explains what additional address services were run such as RDI, eLOT, etc


[1] This value is dependent on the amount data that is available for the address. The service then analyzes the data to estimate the integrity of the address.

[2] An unknown return value indicates that either there was not enough information available about the recipient's mail server to determine deliverability or the server is a catch-all. In general, catch-all mail servers will always initially accept an email message, even if the email address does not exist.

[3] New codes and descriptions will be added as new features become available and the number of codes will increase in time. See the table for our current list of codes & descriptions.


References

  1. ^ NCOA Live Best Practices

  • No labels