POST access_tokens/show
This method returns information related with an access token. A single access token is returned 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 that should be returned as a result. The allowed access token identifier fields are the following:
| ||||||||||||
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved access token |
| number | String | The number of the retrieved access token |
| life_cycle_state | String | The state of the retrieved access token which can be one of the following: EFFECTIVE, NOT_EFFECTIVE, PENDING_VERIFICATION |
authentication_code | String | The authentication code of the retrieved access token |
| identifier | String | The identifier of the retrieved access token |
| card_masked_number | String | The masked number of the card as provided
Available from CRM.COM R16.2.0 |
| card_last_4_digits | String | The last 4 digits of the card as provided.
Available from CRM.COM R15.0.0 Deprecated from CRM.COM R16.2.0 |
| verification_code | String | The verification code of the retrieved access token |
| verified_date | Date | The date that the access token was verified |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| verified_by_user | User Object | The user that verified the access token |
| rewards_participant | Rewards Participant Object | The rewards participant associated with the access token |
| accounts_receivable | Accounts Receivable Object | The accounts receivable associated with the access token |
| classification | Access Token Classification Object | The classification of the access token |
Log Information Object | The log information related with the retrieved access token |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"641070EA9DF042E48CDA1B6414ACABC5",
"access_token_identifier": { "authentication_code" : "CCD4537CA4AD4EE8912FFBAE53110601"}
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"log_information":
{
"updated_date": "2015-05-27T12:03:05",
"created_date": "2015-02-16T14:23:46",
"created_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"updated_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "p_xenopoulou",
"username": "p_xenopoulou",
"id": "159C17D9C4B1E48DC129FBC701D38438",
"email": "p_xenopoulou@crm.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"reward_participant":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Havier",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Shemar",
"type": "PERSON",
"id": "E21381FCC07AB01BAAC3851B6C00FFE5",
"name": null,
"company_name": null,
"demographics":
{
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day":
{
"month": null,
"day": null
},
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"id_number": null,
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000418",
"id": "8728513FDA0C6919AE007D84938A835B",
"name": "Havier 6"
},
"number": "28",
"id": "2432994125F2450EBDF84E00B21C89F0"
},
"authentication_code": "CCD4537CA4AD4EE8912FFBAE53110601",
"accounts_receivable":
{
"account_owner":
{
"last_name": "Havier",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Shemar",
"type": "PERSON",
"id": "E21381FCC07AB01BAAC3851B6C00FFE5",
"name": "Havier Shemar",
"company_name": null,
"demographics":
{
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence":
{
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
},
"name_day":
{
"month": null,
"day": null
},
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"id_number": null,
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000418",
"id": "8728513FDA0C6919AE007D84938A835B",
"name": "Havier 6"
},
"life_cycle_state": "EFFECTIVE",
"identifier": "abc567!",
"number": "35",
"id": "CDC003FAB1204830ACED364BA77EC18D"
}
}
GET access_tokens/list
This method returns information related with multiple access tokens, which are related either with an accounts receivable or a rewards participant. Multiple access tokens are returned by each call.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The identifier of the accounts receivable related with the access token. The available accounts receivable identifier fields are the following:
| ||||||||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The identifier of the rewards participant related with the access token. The available rewards participant identifier fields are the following:
| ||||||||||||
classification_identifier (optional) | Access Token Classification Identifier | The identifier of the access token classification that retrieved access tokens should have. If specified then only access tokens having that classification will be retrieved. The allowed access token classification identifier fields are the following:
| ||||||||||||
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved access token |
| number | String | The number of the retrieved access token |
| life_cycle_state | String | The state of the retrieved access token which can be one of the following: EFFECTIVE, NOT_EFFECTIVE, PENDING_VERIFICATION |
authentication_code | String | The authentication code of the retrieved access token |
| identifier | String | The identifier of the retrieved access token |
| card_masked_number | String | The masked number of the card as provided
Available from CRM.COM R16.2.0 |
| card_last_4_digits | String | The last 4 digits of the card as provided.
Available from CRM.COM R15.0.0 Deprecated from CRM.COM R16.2.0 |
| verification_code | String | The verification code of the retrieved access token |
| verified_date | Date | The date that the access token was verified |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| verified_by_user | User Object | The user that verified the access token |
| rewards_participant | Rewards Participant Object | The rewards participant associated with the access token |
| accounts_receivable | Accounts Receivable Object | The accounts receivable associated with the access token |
| classification | Access Token Classification Object | The classification of the access token |
Log Information Object | The log information related with the retrieved access token |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": [
{
"verification_code": null,
"log_information": {
"updated_date": "2016-05-20T10:06:08",
"created_date": "2016-05-19T14:26:53",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"reward_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Andreou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Kokos",
"type": "PERSON",
"id": "32120E4E8518419FA1A017E200F35D8E",
"name": "Andreou Kokos",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "9655851",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001018",
"id": "3D2B233237C9492DB23B1A8D3935AAAA",
"name": "ACR001018"
},
"number": "115",
"id": "41BDE8D9D1AE4F46A1948C85E5644A66"
},
"authentication_code": "pk_test4",
"life_cycle_state": "EFFECTIVE",
"verified_date": null,
"accounts_receivable": null,
"classification": {
"id": "FD034DB5BEB34D07A57A4DE075B5F649",
"name": "PK Main Access Token Classification ",
"alternative_code": "MATC_2"
},
"number": "ACT0000000231",
"identifier": "pk6@crm.com",
"id": "33592E8A66A0442FA5B70C077A33010D",
"verified_by_user": null
},
{
"verification_code": null,
"log_information": {
"updated_date": "2016-05-20T10:04:41",
"created_date": "2016-05-20T10:04:24",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"reward_participant": {
"accounts_receivable": {
"account_owner": {
"last_name": "Andreou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Kokos",
"type": "PERSON",
"id": "32120E4E8518419FA1A017E200F35D8E",
"name": "Andreou Kokos",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "9655851",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR001018",
"id": "3D2B233237C9492DB23B1A8D3935AAAA",
"name": "ACR001018"
},
"number": "115",
"id": "41BDE8D9D1AE4F46A1948C85E5644A66"
},
"authentication_code": "76456",
"life_cycle_state": "EFFECTIVE",
"verified_date": null,
"accounts_receivable": null,
"classification": {
"id": "FD034DB5BEB34D07A57A4DE075B5F649",
"name": "PK Main Access Token Classification ",
"alternative_code": "MATC_2"
},
"number": "ACT0000000246",
"identifier": null,
"id": "5E8AB892776745588B8611E86BB6B571",
"verified_by_user": null
}
]
}
GET access_tokens/get_not_associated
This method returns all the access tokens which are not associated with an existing entity. Multiple access tokens are retrieved by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
| number (mandatory) | Number | The number of access tokens that should be retrieved |
life_cycle_state (optional) | String | The life cycle state of the access tokens that should be retrieved. The allowed options are EFFECTIVE or NOT_EFFECTIVE or PENDING_VERIFICATION |
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved access token |
| number | String | The number of the retrieved access token |
| life_cycle_state | String | The state of the retrieved access token which can be one of the following: EFFECTIVE, NOT_EFFECTIVE, PENDING_VERIFICATION |
authentication_code | String | The authentication code of the retrieved access token |
| identifier | String | The identifier of the retrieved access token |
| card_masked_number | String | The masked number of the card as provided
Available from CRM.COM R16.2.0 |
| card_last_4_digits | String | The last 4 digits of the card as provided.
Available from CRM.COM R15.0.0 Deprecated from CRM.COM R16.2.0 |
| verification_code | String | The verification code of the retrieved access token |
| verified_date | Date | The date that the access token was verified |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| verified_by_user | User Object | The user that verified the access token |
| rewards_participant | Rewards Participant Object | The rewards participant associated with the access token |
| accounts_receivable | Accounts Receivable Object | The accounts receivable associated with the access token |
| classification | Access Token Classification Object | The classification of the access token |
Log Information Object | The log information related with the retrieved access token |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"log_information":
{
"updated_date": "2015-05-27T11:14:32",
"created_date": "2015-01-29T12:22:58",
"created_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"updated_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "emichailidou",
"username": "emichailidou",
"id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
"email": "e_michailidou@crm.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"reward_participant": null,
"authentication_code": "4B686F53D4F498EFE54FBA13707CC896",
"life_cycle_state": "NOT_EFFECTIVE",
"accounts_receivable": null,
"number": "31",
"identifier": "cd0900001!",
"id": "0B417EC816D48FE604FDBAA3D3668D21"
},
{
"log_information":
{
"updated_date": "2015-05-27T09:57:38",
"created_date": "2015-05-27T09:25:38",
"created_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"updated_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"reward_participant": null,
"authentication_code": "23131234",
"life_cycle_state": "NOT_EFFECTIVE",
"accounts_receivable": null,
"number": "49",
"identifier": "123145as",
"id": "1D734D9AD4484E93B248921080C4C494"
},
{
"log_information":
{
"updated_date": "2015-01-13T15:46:41",
"created_date": "2015-01-09T15:15:23",
"created_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"updated_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "p_xenopoulou",
"username": "p_xenopoulou",
"id": "159C17D9C4B1E48DC129FBC701D38438",
"email": "p_xenopoulou@crm.com"
},
"updated_by_user":
{
"person_name": "p_xenopoulou",
"username": "p_xenopoulou",
"id": "159C17D9C4B1E48DC129FBC701D38438",
"email": "p_xenopoulou@crm.com"
}
},
"reward_participant": null,
"authentication_code": "21A8D8A1EF9E37F43E863D78466C99D1",
"life_cycle_state": "NOT_EFFECTIVE",
"accounts_receivable": null,
"number": "5",
"identifier": "!12ABCD",
"id": "2436DBBFFC1CE395B7F7B9C3D904031F"
},
{
"log_information":
{
"updated_date": "2015-05-27T11:27:50",
"created_date": "2015-05-27T09:21:31",
"created_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"updated_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"reward_participant": null,
"authentication_code": "112233665",
"life_cycle_state": "EFFECTIVE",
"accounts_receivable":
{
"account_owner":
{
"last_name": null,
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile":
{
"annual_turnover": null,
"tax_reference_number": null,
"profile_year": 2014,
"number_of_employees": 30,
"established_date": "2014-02-05T00:00:00",
"industry_sector": null,
"vat_registration_number": "11552546",
"registered_in_country": null,
"vat_registered_by": null,
"vat_registration_date": null,
"industry": null,
"registration_number": "128596663"
},
"title": null,
"first_name": null,
"type": "COMPANY",
"id": "DF91C1AD6E8BB995377B3C29C5F5FFAB",
"name": null,
"company_name": "Walt Disney Museum",
"demographics": null
},
"life_cycle_state": "TERMINATED",
"number": "ACR000604",
"id": "E337DA5F4A834E188B3A60E3E36F1B51",
"name": "ACR000604"
},
"number": "47",
"identifier": "4857ap23",
"id": "4754A06B5F2F45A1B7CB7CCB85DEA473"
},
{
"log_information":
{
"updated_date": "2015-05-27T09:32:24",
"created_date": "2015-05-27T09:23:57",
"created_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"updated_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"reward_participant": null,
"authentication_code": "66554433",
"life_cycle_state": "NOT_EFFECTIVE",
"accounts_receivable": null,
"number": "48",
"identifier": "99aw2311",
"id": "4B7037868CE14A7D863E56251A629A20"
}
]
}
POST access_tokens/create
This method creates an access token. Single access tokens can be created by each call.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
authentication_code (optional) | String | The authentication code of the access token that will be created. If not specified then it will be generated automatically. | ||||||||||||
identifier (mandatory on conditions) | String | The identifier of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code. | ||||||||||||
pass_code (mandatory on conditions) | String | The pass code of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code, although it is always mandatory if an identifier was specified. | ||||||||||||
accounts_receivable_identifier (optional) | Accounts Receivable Identifier | The identifier of the accounts receivable that will be related with the access token. The available accounts receivable identifier fields are the following:
| ||||||||||||
rewards_participant_identifier (optional) | Rewards Participant Identifier | The identifier of the rewards participant that will be related with the access token. The available rewards participant identifier fields are the following:
Note that if an accounts receivable is also specified, then the rewards participant should be owned by that accounts receivable | ||||||||||||
classification_identifier (optional) | Access Token Classification Identifier | The identifier of the access token classification that will be related with the access token. The allowed access token classification identifier fields are the following:
| ||||||||||||
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.e
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved access token |
| number | String | The number of the retrieved access token |
| life_cycle_state | String | The state of the retrieved access token which can be one of the following: EFFECTIVE, NOT_EFFECTIVE, PENDING_VERIFICATION |
authentication_code | String | The authentication code of the retrieved access token |
| identifier | String | The identifier of the retrieved access token |
| card_masked_number | String | The masked number of the card as provided
Available from CRM.COM R16.2.0 |
| card_last_4_digits | String | The last 4 digits of the card as provided.
Available from CRM.COM R15.0.0 Deprecated from CRM.COM R16.2.0 |
| verification_code | String | The verification code of the retrieved access token |
| verified_date | Date | The date that the access token was verified |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| verified_by_user | User Object | The user that verified the access token |
| rewards_participant | Rewards Participant Object | The rewards participant associated with the access token |
| accounts_receivable | Accounts Receivable Object | The accounts receivable associated with the access token |
| classification | Access Token Classification Object | The classification of the access token |
Log Information Object | The log information related with the retrieved access token |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"43512326DEE44DF18D37EAAB6A46DA4C",
"authentication_code" : "180581",
"identifier":"18555",
"pass_code":"ap!n3w$",
"accounts_receivable_identifier" : { "number" : "ACR000783"}
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"log_information":
{
"updated_date": "2015-10-15T09:47:49",
"created_date": "2015-10-15T09:47:48",
"created_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"reward_participant": null,
"authentication_code": "180581",
"accounts_receivable":
{
"account_owner":
{
"last_name": "Tyler",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Rose",
"type": "PERSON",
"id": "2666B580BF60454C97D5DB2DDCD50BAE",
"name": null,
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day":
{
"month": null,
"day": null
},
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"id_number": "4324",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000783",
"id": "0B06C58003B4456281DC97B73C5050EE",
"name": "ACREC-04-RT"
},
"life_cycle_state": "EFFECTIVE",
"identifier": "18555",
"number": "ACT0000000142",
"id": "7DD8EE7C341B4627A45A1E2D64C2999E"
}
}
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"authentication_code" : "Joanna",
"identifier":"password12!",
"pass_code":"pass12!",
"accounts_receivable_identifier" : { "number" : "162"},
"fields_set":"id,number,life_cycle_state,authentication_code,identifier,accounts_receivable"
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"authentication_code": "Joanna",
"accounts_receivable": {
"account_owner": {
"last_name": "Mercer",
"middle_name": "111111111",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mr",
"first_name": "Ben11 omonoia",
"type": "PERSON",
"id": "475904FB959FE8D3DDAEB22FBFEC5FFB",
"name": "Mercer Ben11 omonoia",
"company_name": null,
"demographics": {
"gender": "MALE",
"passport_issued_by_country": {
"three_character_code": "AND",
"two_character_code": "AD",
"id": "132",
"name": "ANDORRA",
"alternative_code": null
},
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
},
"name_day": {
"month": 6,
"day": 14
},
"date_of_birth": {
"month": 11,
"day": 9,
"year": 1963
},
"id_number": "1212125",
"industry": {
"id": "31BC2070C79EAE5455BFAD41599C5190",
"name": "Marketing1",
"code": "MK"
},
"id_issued_by_country": {
"three_character_code": "DZA",
"two_character_code": "DZ",
"id": "130",
"name": "ALGERIA",
"alternative_code": null
}
}
},
"life_cycle_state": "ACTIVE",
"number": "162",
"id": "3C66BD54CCDB6BC1096C23F6D8899752",
"name": "Ben Mercer 1"
},
"life_cycle_state": "EFFECTIVE",
"identifier": "password12!",
"number": "ACT0000000338",
"id": "DA28B48FF08346199583CA7F20088CC1"
}
}
POST access_tokens/update
This method updates access tokens. A single access token can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.
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 that should be updated. The allowed access token identifier fields are the following:
| ||||||||||||
authentication_code (optional) | String | The authentication code of the access token that will be updated. Is specified as null then the authentication code will be regenerated automatically | ||||||||||||
identifier (mandatory on conditions) | String | The identifier of the access token that will be update. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code. | ||||||||||||
pass_code (mandatory on conditions) | String | The pass code of the access token that will be updated. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code, although it is always mandatory if an identifier was specified. |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved access token |
| number | String | The number of the retrieved access token |
| life_cycle_state | String | The state of the retrieved access token which can be one of the following: EFFECTIVE, NOT_EFFECTIVE, PENDING_VERIFICATION |
authentication_code | String | The authentication code of the retrieved access token |
| identifier | String | The identifier of the retrieved access token |
| card_masked_number | String | The masked number of the card as provided
Available from CRM.COM R16.2.0 |
| card_last_4_digits | String | The last 4 digits of the card as provided.
Available from CRM.COM R15.0.0 Deprecated from CRM.COM R16.2.0 |
| verification_code | String | The verification code of the retrieved access token |
| verified_date | Date | The date that the access token was verified |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| verified_by_user | User Object | The user that verified the access token |
| rewards_participant | Rewards Participant Object | The rewards participant associated with the access token |
| accounts_receivable | Accounts Receivable Object | The accounts receivable associated with the access token |
| classification | Access Token Classification Object | The classification of the access token |
Log Information Object | The log information related with the retrieved access token |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"A4F19B70D95D4DE09C3A9FC720A33A49",
"access_token_identifier" : {"authentication_code":"CCD4537CA4AD4EE8912FFBAE53110601"},
"authentication_code":"testpassnew1",
"identifier":"api1test12up",
"pass_code":"api11112"
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"log_information":
{
"updated_date": "2015-05-27T12:50:22",
"created_date": "2015-02-16T14:23:46",
"created_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"updated_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "p_xenopoulou",
"username": "p_xenopoulou",
"id": "159C17D9C4B1E48DC129FBC701D38438",
"email": "p_xenopoulou@crm.com"
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"reward_participant":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Havier",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Shemar",
"type": "PERSON",
"id": "E21381FCC07AB01BAAC3851B6C00FFE5",
"name": null,
"company_name": null,
"demographics":
{
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"name_day":
{
"month": null,
"day": null
},
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"id_number": null,
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000418",
"id": "8728513FDA0C6919AE007D84938A835B",
"name": "Havier 6"
},
"number": "28",
"id": "2432994125F2450EBDF84E00B21C89F0"
},
"authentication_code": "testpassnew1",
"accounts_receivable":
{
"account_owner":
{
"last_name": "Havier",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Shemar",
"type": "PERSON",
"id": "E21381FCC07AB01BAAC3851B6C00FFE5",
"name": "Havier Shemar",
"company_name": null,
"demographics":
{
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence":
{
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
},
"name_day":
{
"month": null,
"day": null
},
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"id_number": null,
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000418",
"id": "8728513FDA0C6919AE007D84938A835B",
"name": "Havier 6"
},
"life_cycle_state": "EFFECTIVE",
"identifier": "api1test12up",
"number": "35",
"id": "CDC003FAB1204830ACED364BA77EC18D"
}
}
POST access_tokens/verify
This method verifies access tokens which are in Pending Verification life cycle state. A single access token can be verified 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 that should be verified. The allowed access token identifier fields are the following:
| ||||||||||||
verification_code (mandatory) | String | The verification code which is needed in order to verify the access token |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved access token |
| number | String | The number of the retrieved access token |
| life_cycle_state | String | The state of the retrieved access token which can be one of the following: EFFECTIVE, NOT_EFFECTIVE, PENDING_VERIFICATION |
authentication_code | String | The authentication code of the retrieved access token |
| identifier | String | The identifier of the retrieved access token |
| card_masked_number | String | The masked number of the card as provided
Available from CRM.COM R16.2.0 |
| card_last_4_digits | String | The last 4 digits of the card as provided.
Available from CRM.COM R15.0.0 Deprecated from CRM.COM R16.2.0 |
| verification_code | String | The verification code of the retrieved access token |
| verified_date | Date | The date that the access token was verified |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| verified_by_user | User Object | The user that verified the access token |
| rewards_participant | Rewards Participant Object | The rewards participant associated with the access token |
| accounts_receivable | Accounts Receivable Object | The accounts receivable associated with the access token |
| classification | Access Token Classification Object | The classification of the access token |
Log Information Object | The log information related with the retrieved access token |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"B394F93D967845AFBC884420592EAA0B",
"access_token_identifier":{"authentication_code":"7"},
"verification_code":"273562"
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"log_information":
{
"updated_date": "2015-11-27T16:08:56",
"created_date": "2015-11-26T19:26:43",
"created_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"verification_code": "273562",
"reward_participant": null,
"authentication_code": "7",
"accounts_receivable":
{
"account_owner":
{
"last_name": "Papapavlou",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Miss",
"first_name": "Loukia",
"type": "PERSON",
"id": "37072CF6ED884737B6592A7CBB6D5342",
"name": "Papapavlou Loukia",
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence":
{
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day":
{
"month": null,
"day": null
},
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"id_number": "LP1234",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000852",
"id": "A86D415E729945C6933177D83319FBE6",
"name": "ACR000852"
},
"verified_date": "Fri Nov 27 16:08:55 EET 2015",
"life_cycle_state": "EFFECTIVE",
"identifier": "lpapap@gmail.com",
"number": "ACT0000000177",
"id": "E8D62A98078A44F79646E4CB4C7DAB19",
"verified_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
}
}
POST access_tokens/reset_pass_code
This method resets an access token pass code to a random 6 digit number, by providing the access token authentication code or identifier. This method can be applied only on effective access tokens. A single access token can be update by each call.
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
authentication_code (semi-optional) | String | The authentication code of the access token |
identifier (semi-optional) | String | The identifier of the access token. If the identifier is specified then it will be validated against the specified pass code |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved access token |
| number | String | The number of the retrieved access token |
| life_cycle_state | String | The state of the retrieved access token which can be one of the following: EFFECTIVE, NOT_EFFECTIVE, PENDING_VERIFICATION |
authentication_code | String | The authentication code of the retrieved access token |
| identifier | String | The identifier of the retrieved access token |
| random_pass_code | String | The pass code that was randomly generated (not encrypted) |
Log Information Object | The log information related with the retrieved access token |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"7031041502C7442CA01FA677D0CCDB4B",
"authentication_code":"7"
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"log_information": {
"updated_date": "2015-12-28T15:22:07",
"created_date": "2015-11-26T19:26:43",
"created_by_unit": {
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"authentication_code": "7",
"life_cycle_state": "EFFECTIVE",
"identifier": "lpapap@gmail.com",
"number": "ACT0000000177",
"id": "E8D62A98078A44F79646E4CB4C7DAB19",
"random_pass_code": "967412"
}
}