ConfirmIdentity

Use this call to confirm a user's identity during the consent flow when you have configured your application's consent flow to use "IDVerification" as your application's authorization type. "IDVerification" is the preferred authorization type for applications that need to confirm their users' identity, but don't need to use a token to access users' private data.

The context in which you use this call is described in Setting Up an Application to Receive Tokens.

ConfirmIdentity requires the SessionID value that was created when the user initiated the consent flow. Use the GetSessionID call to obtain a valid SessionID value.

Unlike other Trading API calls, ConfirmIdentity requires your application keys (AppID, DevID, and CERT). Include the application keys in the SOAP header for SOAP requests, or in the HTTP header for XML requests.

This call can be tested in the Sandbox environment.

See Working with token/authentication calls.

Input

See also Samples.

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<ConfirmIdentityRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <SessionID> string </SessionID>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</ConfirmIdentityRequest>

Output

See also Samples.

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<ConfirmIdentityResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <UserID> string </UserID>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</ConfirmIdentityResponse>

Detail Controls

DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Returns a UserID value for the user who has completed the authentication consent flow.

Description

In this call, the authentication values for AppID, DevID, and Cert are supplied in the X-EBAY-API-APP-NAME, X-EBAY-API-DEV-NAME, and X-EBAY-API-CERT-NAME HTTP headers, respectively. The response contains the UserID value.

Input

XML format.

<?xml version="1.0" encoding="utf-8"?>
<ConfirmIdentityRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <SessionID>B**************************************6</SessionID>
</ConfirmIdentityRequest>

Output

XML format.
<?xml version="1.0" encoding="utf-8"?>
<ConfirmIdentityResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-04T17:14:50.603Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1131</Version>
  <Build>E1131_CORE_API6_19105226_R1</Build>
  <UserID>B********r</UserID>
</ConfirmIdentityResponse>

Change History