Onboard a Person

POST: Onboard a Person

The /evaluations endpoint creates users and runs any KYC checks selected for your onboarding flow. Once the individual is resolved and there is no need for further information, the response will return all matching attributes and information from the services run. If additional information is required, the response body will detail needed data and formatting.

Create a POST request with the required information.

HTTP Request: POST https://sandbox.alloy.co/v1/evaluations

See below for sample request and response body, as well as the schema.

Sample Request Body:

{
    "phone_number": "18042562188",
    "name_first": "John",
    "name_last": "Doe",
    "email_address": "[email protected]",
    "birth_date": "1985-01-23",
    "address_line_1": "1717 E Test St",
    "address_city": "Richmond",
    "address_state": "VA",
    "document_ssn": "123456789",
    "address_postal_code": "23220",
    "address_country_code": "US",
    "social_twitter": "dog_rates"
  }

Sample Successful Response Body:

{
  "status_code": 201,
  "error": null,
  "timestamp": 1497309594913,
  "evaluation_token": "S-BNTwVDLrlRvHbKVhRa8X",
  "entity_token": "P-2WU9staJ5pVCQ6xgn3KV",
  "application_token": "token",
  "application_version_id": 14,
  "summary": {
    "result": "success",
    "score": 0.99,
    "tags": ["Address Match", "Phone Match"],
    "outcome": "Approved",
    "services": {
      "Emailage": "executed",
      "Socure": "executed",
      "White Pages Pro": "executed"
    }
  },
  "supplied": {
    "phone_number": "18042562188",
    "name_first": "John",
    "name_last": "Doe",
    "email_address": "[email protected]",
    "birth_date": "1985-01-23",
    "address_line_1": "1717 E Test St",
    "address_city": "Richmond",
    "address_state": "VA",
    "document_ssn": "123456789",
    "address_postal_code": "23220",
    "address_country_code": "US",
    "social_twitter": "dog_rates"
  },
  "formatted": {
    "phone_number": "+18042562188",
    "name_first": "John",
    "name_last": "Doe",
    "email_address": "[email protected]",
    "birth_date": "1985-01-23",
    "address_line_1": "1717 E Test St",
    "address_city": "Richmond",
    "address_state": "VA",
    "document_ssn": "123456789",
    "address_postal_code": "23220",
    "address_country_code": "US",
    "social_twitter": "dog_rates"
  },
  "matching": {
    "name": {
      "score": 0.99,
      "matched": ["Emailage", "Socure"],
      "unmatched": []
    },
    "phone": {
      "score": 1,
      "matched": ["White Pages Pro", "Socure"],
      "unmatched": []
    },
    "address": {
      "score": 1,
      "matched": ["White Pages Pro", "Socure"],
      "unmatched": []
    },
    "email": {
      "score": 0.99,
      "matched": ["White Pages Pro", "Socure"],
      "unmatched": []
    },
    "ssn": {
      "score": 0.99,
      "matched": ["Socure"],
      "unmatched": []
    },
    "dob": {
      "score": 0.99,
      "matched": ["Socure"],
      "unmatched": []
    }
  },
  "diligence": {
    "watchlists": {
      "lists": ["BES", "CFTC", "DTC", "EUDT", "FBI", "FCEN", "FAR", "IMW", "OFAC", "OCC", "OSFI",
        "PEP", "SDT", "UNNT", "BIS", "WBIF", "Socure Watchlists Tier 1"
      ],
      "matches": []
    },
    "fraud": {
      "score": 0.02,
      "flags": []
    },
    "financial": null,
    "identity_questions": null
  },
  "related_data": {
    "social": [{
      "type": "Twitter",
      "url": "https://twitter.com/blankslateio",
      "id": "blankslateio"
    }, {
      "type": "Klout",
      "url": "http://klout.com/blankslateio",
      "id": "blankslateio"
    }, {
      "type": "Twitter",
      "url": "https://twitter.com/dog_rates",
      "id": "dog_rates"
    }]
  },
  "raw_responses": {
    "Emailage": [ ... ],
    "White Pages Pro": [ ... ],
    "Socure": [ ... ]
  },
  "formatted_responses": {
    "Emailage": { ... },
    "White Pages Pro": { ... },
    "Socure": { ... }
  },
  "audit_archive": null
}

More information needed:

{
  "evaluation_token": "S-eJ38yUNDqcMxKwwdxbya",
  "error": null,
  "timestamp": 1475258667031,
  "entity_token": "P-Hp6QxEGwNg6sgYNuXdqF",
  "application_token": "token",
  "application_version_id": 11,
  "required": [
    {
      "key": "answers",
      "type": "object",
      "description": "Object containing answers to out of wallet question prompts.",
      "template": {
        "answers": [
          {
            "question_id": 1,
            "answer_id": 0
          },
          {
            "question_id": 2,
            "answer_id": 0
          },
          {
            "question_id": 3,
            "answer_id": 0
          },
          {
            "question_id": 4,
            "answer_id": 0
          },
          {
            "question_id": 5,
            "answer_id": 0
          }
        ]
      }
    }
  ],
  "optional": [],
  "prompts": {
    "answers": {
      "questions": [
        {
          "id": 1,
          "question": "What state was your SSN issued in?",
          "answers": [
            {
              "id": 1,
              "answer": "Arkansas"
            },
            {
              "id": 2,
              "answer": "Alabama"
            },
            {
              "id": 3,
              "answer": "West Virginia"
            },
            {
              "id": 4,
              "answer": "Virginia"
            },
            {
              "id": 5,
              "answer": "None Of The Above"
            }
          ]
        },
        <...>
      ]
    }
  }
}

Parameters:

• denotes required fields (varies based on data sources)

Response Schema: