Method: Plivo::Resources::IdentityInterface#update

Defined in:
lib/plivo/resources/identities.rb

#update(identity_id, file_to_upload = nil, options = nil) ⇒ Identity

Update an identity

Parameters:

  • identity_id (String)
  • file_to_upload (String) (defaults to: nil)
  • options (Hash) (defaults to: nil)

Options Hash (options):

  • :salutation (String) —

    • One of Mr or Ms

  • :first_name (String) —

    • First name of the user for whom the identity is created

  • :last_name (String) —

    • Last name of the user for whom the identity is created

  • :country_iso (String) —

    • Country ISO 2 code

  • :birth_place (String) —

    • Birthplace of the user for whom the identity is created

  • :birth_date (String) —

    • Birth date in yyyy-mm-dd format of the user for whom the identity is created

  • :nationality (String) —

    • Nationality of the user for whom the identity is created

  • :id_nationality (String) —

    • Nationality mentioned in the identity proof

  • :id_issue_date (String) —

    • Issue date in yyyy-mm-dd mentioned in the identity proof

  • :id_type (String) —

    -

  • :id_number (String) —

    • The unique number on the identifier

  • :address_line1 (String) —

    • Building name/number

  • :address_line2 (String) —

    • The street name/number of the address

  • :city (String) —

    • The city of the address for which the address proof is created

  • :region (String) —

    • The region of the address for which the address proof is created

  • :postal_code (String) —

    • The postal code of the address that is being created

  • :alias (String) —

    • Alias name of the identity

  • :business_name (String) —

    • Business name of the user for whom the identity is created.

  • :auto_correct_address (String) —

    • If set to true, the address will be auto-corrected by the system if necessary. The param needs to be set to false explicitly so that it is not auto-corrected.

  • :fiscal_identification_code (String) —

    • The code is valid for businesses alone

  • :street_code (String) —

    • Street code of the address

  • :municipal_code (String) —

    • Municipal code of the address

  • :callback_url (String) —

    • The callback URL that gets the result of identity creation POSTed to.

  • :subaccount (String) —

    • The link to the subaccount resource associated with the application. If the application belongs to the main account, this field will be null.

Returns:



304
305
306
307
 
# File 'lib/plivo/resources/identities.rb', line 304

def update(identity_id, file_to_upload=nil, options=nil)
  Identity.new(@_client,
              resource_id: identity_id).update(file_to_upload, options)
end