Depending on applicable regulations or business limitations, specific API requests may not be available for your use.

Verify Member Identity

Description

This request triggers the Customer Information Program (CIP) verification for the member specified. If the specified member has already passed the CIP verification, a 303 See Other response will return with the ‘Location’ HTTP header field, which links to ‘Get Member Verification Status’ endpoint. If a prospective member fails this verification you will receive an error message.

Note:

Adding the following header field in the request, ‘X-Force-CIP-Failure: true’, no matter whether the member has been verified or not, will always return the verification failure response with the error message. This header flag helps to mimic what happens in the production environment when the member does not pass the CIP verification. Notice that the flag can also be set in the production environment and should be used when you wish to intentionally mark the member unverified.

Request URL

Syntax POST /restapi/members/{loginid}/verifications
Example URL https://api.uat.foliofn.com/restapi/memberss/testusername/verifications

Request Example


POST /restapi/members/testusername/verifications HTTP/1.1
Content-Type: application/json

With ‘X-Force-CIP-Failure’ flag


POST /restapi/members/testusername/verifications HTTP/1.1
X-Force-CIP-Failure: true
Content-Type: application/json

Response Example

Successfully pass the verification


HTTP/1.1 201 Created
Location: https://api.uat.foliofn.com/restapi/members/testusername/verifications

Fail the verification


HTTP/1.1 400 Bad Request
Transfer-Encoding: chunked
Content-Type: application/json
[{“type”:“VALIDATION_RULE”,“errorCode”:“member.riskwise.rule”}]

Member has already passed verification


HTTP/1.1 303 See Other
Location: https://api.uat.foliofn.com/restapi/members/testusername/verifications

Member verification is pending (refer to asynchronousSSNValidation=true for Create a Member)


HTTP/1.1 202 Accepted

Error Codes

HTTP Code Status Field Code Message Description
400 - member.riskwise.rule - The member fails CIP verification.
503 - - Customer Identification Program is unavailable now. The specified service is not available.

Change Log

04/21/2017

  1. Added possible response for pending member verification

10/16/2015

  1. New documentation.

Getting Started

REST APIs

Resources

Developer Home