API specific error responses

The following errors occur in response to API-specific error use cases.

  • This error occurs when the challenge token used for user authentication is invalid.

    "challengeTokenUnacceptable": {
      "reason": "INVALID|EXPIRED"
    }
    
  • This error occurs when the offer is not valid or available anymore

    "offerNotAvailable": {
      "reason": "CLAIMED|EXPIRED"
    }
    
  • This error will occur when the requested field mask is unknown on the partner side, or has not been agreed upon.

    "unknownFieldMask": {
      "fieldMaskNames": ["MAIDEN_NAME"]
    }
    
  • This error occurs when a requested field mask is detected by the partner, but there is no data available.

    "dataNotFound": {
      "fieldMaskNames": ["COMMUNICATION_ADDRESS"]
    }