@paciolan/cybersource-sdk/dist/models/risk-v1-address-verifications-post201-response-address-verification-information.d.ts

CyberSource REST API Typescript SDK

/**
 * CyberSource Merged Spec
 * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
 *
 * OpenAPI spec version: 0.0.1
 *
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */
import { RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode } from './risk-v1-address-verifications-post201-response-address-verification-information-bar-code';
import { RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress } from './risk-v1-address-verifications-post201-response-address-verification-information-standard-address';
/**
 *
 * @export
 * @interface RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation
 */
export interface RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation {
    /**
     * Contains the record type of the postal code with which the address was matched.  #### U.S. Addresses Depending on the quantity and quality of the address information provided, this field contains one or two characters:  - One character: sufficient correct information was provided to result in accurate matching. - Two characters: standardization would provide a better address if more or better input address information were available. The second character is D (default).  Blank fields are unassigned. When an address cannot be standardized, how the input data was parsed determines the address type. In this case, standardization may indicate a street, rural route, highway contract, general delivery, or PO box. For possible values, see the description for the `dav_address_type` reply field in [CyberSource Verification Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)  #### All Other Countries This field contains one of the following values: - P: Post. - S: Street. - x: Unknown.
     * @type {string}
     * @memberof RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation
     */
    addressType?: string;
    /**
     *
     * @type {RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode}
     * @memberof RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation
     */
    barCode?: RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode;
    /**
     * Value can be - Canada - US - International The values of errorCode and statusCode mean different things depending on the applicable region. Refer to the guide for more info.
     * @type {string}
     * @memberof RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation
     */
    applicableRegion?: string;
    /**
     * Four-character error code returned for Canadian, US and international addresses. For possible values, see Verification Services guide. The meaning of the errorCode depends on value of applicableRegion.
     * @type {string}
     * @memberof RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation
     */
    errorCode?: string;
    /**
     * Four-to-ten character status code returned for Canadian, US and international addresses. For possible values, see Verification Services guide. The meaning of the errorCode depends on value of applicableRegion.
     * @type {string}
     * @memberof RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation
     */
    statusCode?: string;
    /**
     * Care of data dropped from the standard address.
     * @type {string}
     * @memberof RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation
     */
    careOf?: string;
    /**
     * Indicates the probable correctness of the address match. Returned for U.S. and Canadian addresses. Returns a value from 0-9, where 0 is most likely to be correct and 9 is least likely to be correct, or -1 if there is no address match.
     * @type {number}
     * @memberof RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation
     */
    matchScore?: number;
    /**
     *
     * @type {RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress}
     * @memberof RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation
     */
    standardAddress?: RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress;
}