Developer API

Overview

Account API

Transfer API

Get Registration Profile

GET /registrations/{RegistrationID}

This method returns the state of the registration profile to show whether the Registration ID has been validated. Use this method to check the status of the Registration ID after validation has been attempted, before attempting to create an account.

Status of the registration profile can be retrieved by checking the Status field on the response object. A status of Validated means an account can now be created for the Registration ID.

Profile Status

Status Description
Created The profile has been created but it is neither validated nor has an account been created. Profile must be validated with the method under Validate Registration Profile before an account can be created.
PendingOutOfWallet The profile has been created but must be validated with Out of Wallet questions before an account can be created. See Validate Out of Wallet Questions.
Validated The registration profile has passed validation, and an account can now be created with the method under Create Account.
Registered The registration profile was successfully registered and an account has already been created from the registration profile.
Failed Registration failed. This customer is ineligible for an account. If you believe the information to be incorrect, please create a new customer under Create Registration Profile..

Request Object

Field Type Format Required Description
RegistrationID String Max 19 characters Yes RegistrationID for which to retrieve Status

Response Object

The response objects for this method return information stored in the Green Dot system.

Field Description
Status Status stored for this RegistrationID
FirstName FirstName stored for this RegistrationID.
LastName LastName stored for this RegistrationID.
Address1 Address1 stored for this RegistrationID.
Address2 Address2 stored for this RegistrationID.
City City stored for this RegistrationID.
State State stored for this RegistrationID.
Zip Zip stored for this RegistrationID.
HomePhone HomePhone stored for this RegistrationID.
CellPhone CellPhone stored for this RegistrationID.
Email Email stored for this RegistrationID.
OOWQuiz This field is populated only if the registration profile has a status of PendingOutOfWallet in the Green Dot system.

OOWQuiz Response Objects

OOW validation questions and choices are returned as nested arrays of questions and choices. The unique question IDs and choice IDs are used for validating the customer’s answers with Validate Out of Wallet Questions.

Field Description
QuizID Unique ID for quiz
OOWQuestions[] Array of questions
QuestionID Unique ID for question
QuestionText Question text
Choices[] Array of choices
Choice ID Unique ID for choice
ChoiceText Choice text

OOW Response Sample

{

 “Status”: “pendingoutofwallet”,

 “FirstName”: “John”,

 “LastName”: “Doe”,

 “Address1”: “4321 Doe Lane”,

 “Address2”: “Apt 42”,

 “City”: “JohnVille”,

 “State”: “CA”,

 “Zip”: “94021”,

 “HomePhone”: “3231234567”,

 “CellPhone”: “3231236789”,

 “Email”: “john@doe.com”,

 “OOWQuiz”: {

  “QuizId”: “11020744560576”,

  “OOWQuestions”: [{

   “QuestionId”: “11021629798615”,

   “QuestionText”: “Which of the following colleges have you attended?”,

   “Choices”: [{

    “ChoiceId”: “11026207599274”,

    “ChoiceText”: “Idaho Institute Of Technology”

   },

   {

    “ChoiceId”: “11026207599275”,

    “ChoiceText”: “Carlow University”

   },

   {

    “ChoiceId”: “11026207599276”,

    “ChoiceText”: “Central Georgia Technical College”

   },

   {

    “ChoiceId”: “11026207599277”,

    “ChoiceText”: “Converse College”

   }]

  },

  {

    “QuestionId”: “11021629798616”,

    “QuestionText”: “In which of the following states does ‘Najma Salah’ currently live or own property?”,

    “Choices”: [{

     “ChoiceId”: “11026207599280”,

     “ChoiceText”: “District Of Columbia”

    },

    {

     “ChoiceId”: “11026207599281”,

     “ChoiceText”: “Maine”

    },

    {

     “ChoiceId”: “11026207599282”,

     “ChoiceText”: “Minnesota”

    },

    {

     “ChoiceId”: “11026207599283”,

     “ChoiceText”: “Nevada”

    }]

   },

   {

    “QuestionId”: “11021629798617”,

    “QuestionText”: “From whom did you purchase the property at ‘176 Old Farm Road’?”,

    “Choices”: [{

     “ChoiceId”: “11026207599286”,

     “ChoiceText”: “Boling, Lindsay L”

    },

    {

     “ChoiceId”: “11026207599287”,

     “ChoiceText”: “Emiko Takagi”

    },

    {

     “ChoiceId”: “11026207599288”,

     “ChoiceText”: “Keng Myo & Heidi”

    },

    {

     “ChoiceId”: “11026207599290”,

     “ChoiceText”: “Weng, Vanna E”

    }

     10/27/2015 API Documentation

     http://localhost:64681/docs 8/25

    ]

   }

  ]

 }

}