Initiate verification process from external vendor

Endpoint Parameters

• Request parameters

  Name	Type	Origin	Description
  ClientKey	ClientKey	Route	The client key
  MyInfoRequest	MyInfoRequest	Body	MyInfo Request
  SecureMeRequest	SecureMeRequest	Body	Secure Me Request
  VerificationProviderType	VerificationProvider	Body	Type of verification provider requested

• Response Parameters

  View Response Codes

  Name	Type	Description
  IdentificationUrl	String	The url that will redirect the client to the vendors site for verification

  HTTP Code	Description
  201	Created	Created
  400	Bad Request	Error Code Description InvalidModelState One or more properties of the request are invalid! ValidationFailed One or more of your field values are invalid!
  401	Unauthorized	Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
  404	Not Found	Error Code Description NotFound SignupNotFound The given signup could not be found
  429	Too Many Requests	The request was rejected due to rate limit being exceeded.
  503	Service Unavailable	Service Unavailable.

  Close

• Request Example

  Request URL

  POST /cm/v2/signups/verification/initiate/d2-PzdC5wIPy1284wD-rRA==

  Request Body

  {
    "SecureMeRequest": {
      "CountryCode": "UK",
      "ErrorRedirectUrl": "https://openapi.validate.com",
      "ServiceLanguageCode": "FR",
      "SuccessRedirectUrl": "https://openapi.validate.com",
      "UploadOptions": {
        "Back": "File",
        "Front": "File",
        "Selfie": "Camera"
      }
    },
    "VerificationProviderType": "SecureMe"
  }
  

• Response Example

  Response body

  {
    "IdentificationUrl": "https://secure-me.au10tixservicesstaging.com?token=oBVmsTzsSMGvYES0y9jj&api=aHR0cHM6Ly93ZXUtYXBpLmF1MTB0aXhzZXJ2aWNlc3N0YWdpbmcuY29tL3NlY3VyZS1tZS92MQ%3D%3D&locale=en-us"
  }