Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...


Tip

Available from CRM.COM R13.1.0

Deprecated from CRM.COM R18.0.0


Excerpt

This method sets an access token as Effective. This method can be applied only on not effective access tokens. A single access token can be updated by each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

access_token_identifier

(mandatory)

Access Token Identifier

The identifier of the access token

for

which

a one-time password

will be

generated

set as Effective. The allowed access token identifier fields are the following:

Include Page
V4:access_token_identifier
V4:access_token_identifier

 

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Tip

Available from CRM.COM R10.0.0


Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...

Expand
titleExample 1

HTTP Method: POST 


Request:

Body:

Code Block
languagejavascript
themeConfluence
languagejavascript
linenumberstrue
 
 
{
  "token":"{{token}}",
  "access_token_identifier":{"authentication_code":"99021047380"},
  "fields_set":"verified_by_user,number,rewards_participant,accounts_receivable"
}


Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
 {
    "data": {
        "number": "AT0000000671",
        "accounts_receivable": {
            "number": "ACR0000000069",
            "name": "ACR0000000069 Polina Kestora",
            "id": "8C1E866074D743EE834E910A28C1E582",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
                "company_profile": null,
                "company_name": null,
                "name": "Polina Kestora",
                "last_name": "Kestora",
                "id": "F038161F36C845B98CEE7361A8C92157",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Polina",
                "demographics": {
                    "name_day": {
                        "month": null,
                        "day": null
                    },
                    "id_number": "112233",
                    "gender": "FEMALE",
                    "country_of_residence": {
                        "alternative_code": "IRN",
                        "three_character_code": null,
                        "name": "IRAN (ISLAMIC REPUBLIC OF)",
                        "id": "231",
                        "two_character_code": null
                    },
                    "date_of_birth": {
                        "month": null,
                        "year": null,
                        "day": null
                    },
                    "industry_sector": null,
                    "passport_number": null,
                    "industry": null,
                    "social_security_number": null,
                    "id_issued_by_country": null,
                    "passport_issued_by_country": null
                }
            }
        },
        "verified_by_user": null,
        "rewards_participant": {
            "number": "RP0000000010",
            "accounts_receivable": {
                "number": "ACR0000000069",
                "name": "ACR0000000069 Polina Kestora",
                "id": "8C1E866074D743EE834E910A28C1E582",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": null,
                    "company_name": null,
                    "name": "Polina Kestora",
                    "last_name": "Kestora",
                    "id": "F038161F36C845B98CEE7361A8C92157",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Polina",
                    "demographics": {
                        "name_day": {
                            "month": null,
                            "day": null
                        },
                        "id_number": "112233",
                        "gender": "FEMALE",
                        "country_of_residence": {
                            "alternative_code": "IRN",
                            "three_character_code": null,
                            "name": "IRAN (ISLAMIC REPUBLIC OF)",
                            "id": "231",
                            "two_character_code": null
                        },
                        "date_of_birth": {
                            "month": null,
                            "year": null,
                            "day": null
                        },
                        "industry_sector": null,
                        "passport_number": null,
                        "industry": null,
                        "social_security_number": null,
                        "id_issued_by_country": null,
                        "passport_issued_by_country": null
                    }
                }
            },
            "id": "942D9960056A497FB3BC65EDDF7D8D81",
            "life_cycle_state": "EFFECTIVE"
        }
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}