Geocode

  • Updated

Prerequisite

RATA Geocoding is installed.

Geocoding is the process of converting addresses, such as street addresses, into geographic coordinates (latitude and longitude), which is used to place markers on a map or position the map. The geocoding allows lenders to determine if a loan is located in a low to moderate-income tract, which can enable originators to ask for higher premium pricing when selling their loans on the secondary market.

The RATA geocoding integration is introduced to help FIs meet the legal requirement to report information on loans. This integration allows FIs to enter a street address and then determines the census tract. When an address is not found, the mapping feature enables the user to determine the collateral location based on known landmarks without resorting to a paper map. The system also provides Census demographic information about a particular census tract, including income, population, and housing data. Institutions use this information to assess whether they are meeting the credit needs of the communities in which they operate.

RATA supports multiple APIs methods that return different data sets. The following are the supported APIs:

  • Token Generation: This is the only API call that doesn't require an access token.

    • If called with a username and password, the system authenticates and accesses the user with a refreshed token.

    • If called with a refresh token, the token is authenticated, and a new access token is returned.

  • Geocodes: Addresses are geocoded using as much data as possible that was passed in and using the Mode field in the request to specify how it can be processed and what is returned.This also provides demographics-related data.

Note

The system automatically runs Token Generation API and then uses the token for the Geocoding Integration in sequence without any intervention.

Workflow

The following image illustrates the workflow of APIs:

image idm23491

The following steps explain how to invoke, view details, and history for RATA geocoding integration:

Integration procedure

Prerequisites

Before you proceed to request RATA geocoding information, ensure that the following prerequisites are met:

  • RATA package is Installed.

  • RATA integration is activated.

Note

For more information on activations and configurations, see the RATA Geocoding Integration - Installation section in Q2 Origination Administration Guide.

Steps

To request RATA geocoding information:

  1. Log in to your Salesforce account

  2. Go to image idm3559 (App Launcher) > Applications.

  3. From the list of applications, select the required application ID.

  4. Go to the Collateral tab.

  5. Go to the Geocode section, and expand it.

    image idm23496The Geocode section has the following actions:

    • New Geocode

    • Geocode History

By default, the following Geocode details are displayed (if the users have already requested the New Geocode):

Field Name

Information

INPUT ADDRESS

Note

These are read-only fields.

Address

This field is used to store the address.

City

This field is used to store the name of the city for which the address is specified.

Country

This field represents counties, parishes, territories, and county equivalencies in island territories.

State

This field is used to store the name of the state for which the city is specified.

Zip Code

This field represents the USPS ZIP Code Type indicator relating to the address.

MATCHED ADDRESS

Note

These are read-only fields.

Street Address

This field is used to store the address.

City

This field is used to store the name of the city for which the address is specified.

Country

This field represents counties, parishes, territories, and county equivalencies in island territories.

State

This field is used to store the name of the state for which the city is specified.

Zip Code

This field contains the USPS ZIP Code Type indicator relating to the address.

County Code

This field represents the FIPS 55 County Code for counties, parishes, territories, and county equivalencies in island territories.

MSA/MD Code

This field represents OMB MSA or MD for metropolitan areas, the field returns NA for non-metropolitan areas.

MSA/MD Name

This field represents OMB MSA or MD Name for metropolitan areas.

GEOGRAPHIC DATA

Note

These are read-only fields.

Census Tract Code

This field represents Census Tract as designated by the Census Bureau.

Census Tract Indicator

This field represents the decennial Census Tract Indicator derived from the Decennial Census Tract Percent in relation to the Decennial MSA/MD Median Family Income.

CensusBlock

This field represents the two-digit Census Block as designated by the Census Bureau.

Census Block Group

This field represents the one-digit Census Block Group as designated by the Census Bureau.

Longitude

This field represents the latitude relating to the address.

Latitude

This field represents the longitude relating to the address.

DEMOGRAPHIC DATA

Note

These are read-only fields.

MSA/MD Median Family Income

This field represents the decennial census tract median family income at the time of the last census.

Minority Population

The field represents the minority population count in relation to the total population count in the census tract at the last census.

Tract Median Family Income Percent

This field represents the decennial census tract median family income in relation to the decennial MSA/MD median family.

New Request

  1. To request a new geocode, select New Geocode.

    image idm23501

  2. If you select Yes, Continue, a success message is displayed with the OK button.

  3. Select OK.

    The Input Address, Matched Address, Geographic Data, and Demographic Data are displayed in the New Geocode window, and the respective details are displayed under each tab.

History

  1. To view the geocode history, select Geocode History.

    The Geocode History section displays two columns, namely Geocode Name and Created Date.

    image idm23506

  2. To search location demographic information, go to the search box and specify the name of the Geocode.

    The Geocode Name column is a link. When you select it, the system displays the Geocode Details.

    image idm23511

Errors

For a detailed understanding of error handling messages, see the error messages section.

Code

Reason

400 - Bad Request

The request isn't successful, often due to an invalid, missing, or mutually exclusive parameter.

401 - Unauthorized

No valid API key, referenceID, or entityId was provided.

402 - Request Failed

The parameters are valid, but the request failed.

403 - Forbidden

The API key isn't provisioned to serve the request.

404 - Not Found

The requested resource doesn't exist.

429 - Too Many Requests

You've hit a rate limit. Contact our support group to see how we can help you scale responsibly. We default all clients to a rate limit of 600 transactions per minute per API key.

500, 502, 503, 504 - Server Errors

Something went wrong on Socure's end. On these rare occasions, we're probably already on it but reach out to our support group anyway.

In This Article